4 |
5 | Welcome to the DAV Developer Portal.
6 | Here you will find instructions for running our command line interface, and our various communication protocols.
7 |
8 | Visit our portal: https://developers.dav.network/
9 |
10 | ## Under the hood
11 |
12 | The DAV Developer Portal is powered by [slate](https://github.com/lord/slate).
13 |
14 |
15 |
--------------------------------------------------------------------------------
/Vagrantfile:
--------------------------------------------------------------------------------
1 | Vagrant.configure(2) do |config|
2 | config.vm.box = "ubuntu/trusty64"
3 | config.vm.network :forwarded_port, guest: 4567, host: 4567
4 |
5 | config.vm.provision "bootstrap",
6 | type: "shell",
7 | inline: <<-SHELL
8 | sudo apt-add-repository ppa:brightbox/ruby-ng
9 | sudo apt-get update
10 | sudo apt-get install -yq ruby2.4 ruby2.4-dev
11 | sudo apt-get install -yq pkg-config build-essential nodejs git libxml2-dev libxslt-dev
12 | sudo apt-get autoremove -yq
13 | gem2.4 install --no-ri --no-rdoc bundler
14 | SHELL
15 |
16 | # add the local user git config to the vm
17 | config.vm.provision "file", source: "~/.gitconfig", destination: ".gitconfig"
18 |
19 | config.vm.provision "install",
20 | type: "shell",
21 | privileged: false,
22 | inline: <<-SHELL
23 | echo "=============================================="
24 | echo "Installing app dependencies"
25 | cd /vagrant
26 | bundle config build.nokogiri --use-system-libraries
27 | bundle install
28 | SHELL
29 |
30 | config.vm.provision "run",
31 | type: "shell",
32 | privileged: false,
33 | run: "always",
34 | inline: <<-SHELL
35 | echo "=============================================="
36 | echo "Starting up middleman at http://localhost:4567"
37 | echo "If it does not come up, check the ~/middleman.log file for any error messages"
38 | cd /vagrant
39 | bundle exec middleman server --watcher-force-polling --watcher-latency=1 &> ~/middleman.log &
40 | SHELL
41 | end
--------------------------------------------------------------------------------
/code_of_conduct.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6 |
7 | ## Our Standards
8 |
9 | Examples of behavior that contributes to creating a positive environment include:
10 |
11 | * Using welcoming and inclusive language
12 | * Being respectful of differing viewpoints and experiences
13 | * Gracefully accepting constructive criticism
14 | * Focusing on what is best for the community
15 | * Showing empathy towards other community members
16 |
17 | Examples of unacceptable behavior by participants include:
18 |
19 | * The use of sexualized language or imagery and unwelcome sexual attention or advances
20 | * Trolling, insulting/derogatory comments, and personal or political attacks
21 | * Public or private harassment
22 | * Publishing others' private information, such as a physical or electronic address, without explicit permission
23 | * Other conduct which could reasonably be considered inappropriate in a professional setting
24 |
25 | ## Our Responsibilities
26 |
27 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28 |
29 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30 |
31 | ## Scope
32 |
33 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34 |
35 | ## Enforcement
36 |
37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at tal@dav.network. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38 |
39 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40 |
41 | ## Attribution
42 |
43 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44 |
45 | [homepage]: http://contributor-covenant.org
46 | [version]: http://contributor-covenant.org/version/1/4/
47 |
--------------------------------------------------------------------------------
/config.rb:
--------------------------------------------------------------------------------
1 | # Unique header generation
2 | require './lib/unique_head.rb'
3 |
4 | # Markdown
5 | set :markdown_engine, :redcarpet
6 | set :markdown,
7 | fenced_code_blocks: true,
8 | smartypants: true,
9 | disable_indented_code_blocks: true,
10 | prettify: true,
11 | tables: true,
12 | with_toc_data: true,
13 | no_intra_emphasis: true,
14 | renderer: UniqueHeadCounter
15 |
16 | # Assets
17 | set :css_dir, 'stylesheets'
18 | set :js_dir, 'javascripts'
19 | set :images_dir, 'images'
20 | set :fonts_dir, 'fonts'
21 |
22 | # Activate the syntax highlighter
23 | activate :syntax
24 | ready do
25 | require './lib/multilang.rb'
26 | end
27 |
28 | activate :sprockets
29 |
30 | activate :autoprefixer do |config|
31 | config.browsers = ['last 2 version', 'Firefox ESR']
32 | config.cascade = false
33 | config.inline = true
34 | end
35 |
36 | # Github pages require relative links
37 | activate :relative_assets
38 | set :relative_links, true
39 |
40 | # Build Configuration
41 | configure :build do
42 | # If you're having trouble with Middleman hanging, commenting
43 | # out the following two lines has been known to help
44 | activate :minify_css
45 | activate :minify_javascript
46 | # activate :relative_assets
47 | # activate :asset_hash
48 | # activate :gzip
49 | end
50 |
51 | # Deploy Configuration
52 | # If you want Middleman to listen on a different port, you can set that below
53 | set :port, 4567
54 |
55 | helpers do
56 | require './lib/toc_data.rb'
57 | end
58 |
--------------------------------------------------------------------------------
/deploy.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | set -o errexit #abort if any command fails
3 | me=$(basename "$0")
4 |
5 | help_message="\
6 | Usage: $me [-c FILE] [
-
23 |
- To install DAV CLI using npm, run the following command:
24 |
25 |$ npm install -g dav-cli
26 | - To install DAV CLI using Yarn, run the following command:
27 |
28 |$ yarn global add dav-cli
29 |
dav-cli):
34 |
35 | | Command | 38 |Description | 39 |
|---|---|
-V or --version |
42 | Output the version number | 43 |
-s or --version |
46 | Start a local Ethereum node | 47 |
-p or --port <n> |
50 | Port for Ethereum node to listen to | 51 |
--genkey <s> |
54 | Generate a private-public key pair for a new Identity | 55 |
-r or --register <s> |
58 | Register a new Identity on the blockchain | 59 |
-h or --help |
62 | Output usage information | 63 |
$ dav-cli --start
$ dav-cli --start --port 1234
$ dav-cli --genkey ~/.dav
$ dav-cli --register ~/.dav/0xd14e3aca4d62c8e7b150fc63dabb8fb4b3485263
-
20 |
- Easily run a local testnet containing DAV contracts 21 |
- Generate Identities secured by private public keys and register them on the blockchain 22 |
- Easily scaffold a new project, or modify an existing one to interact with DAV (under development) 23 |
-
26 |
27 |
-
34 |
35 | 
36 | 
37 | 
38 | 
39 | 
40 | 
41 | 
42 | 
43 | 
44 |
- s selected by tocListSelector
71 | // .active-expanded is applied to the ToC links that are parents of this one
72 | $toc.find(".active").removeClass("active");
73 | $toc.find(".active-parent").removeClass("active-parent");
74 | $best.addClass("active");
75 | $best.parents(tocListSelector).addClass("active").siblings(tocLinkSelector).addClass('active-parent');
76 | $best.siblings(tocListSelector).addClass("active");
77 | $toc.find(tocListSelector).filter(":not(.active)").slideUp(150);
78 | $toc.find(tocListSelector).filter(".active").slideDown(150);
79 | // TODO remove classnames
80 | document.title = $best.data("title") + " – " + originalTitle;
81 | }
82 | };
83 |
84 | var makeToc = function() {
85 | recacheHeights();
86 | refreshToc();
87 |
88 | $("#nav-button").click(function() {
89 | $(".toc-wrapper").toggleClass('open');
90 | $("#nav-button").toggleClass('open');
91 | return false;
92 | });
93 | $(".page-wrapper").click(closeToc);
94 | $(".toc-link").click(closeToc);
95 |
96 | // reload immediately after scrolling on toc click
97 | $toc.find(tocLinkSelector).click(function() {
98 | setTimeout(function() {
99 | refreshToc();
100 | }, 0);
101 | });
102 |
103 | $(window).scroll(debounce(refreshToc, 200));
104 | $(window).resize(debounce(recacheHeights, 200));
105 | };
106 |
107 | makeToc();
108 |
109 | window.recacheHeights = recacheHeights;
110 | window.refreshToc = refreshToc;
111 | }
112 |
113 | window.loadToc = loadToc;
114 | })();
115 |
--------------------------------------------------------------------------------
/source/javascripts/lib/_energize.js:
--------------------------------------------------------------------------------
1 | /**
2 | * energize.js v0.1.0
3 | *
4 | * Speeds up click events on mobile devices.
5 | * https://github.com/davidcalhoun/energize.js
6 | */
7 |
8 | (function() { // Sandbox
9 | /**
10 | * Don't add to non-touch devices, which don't need to be sped up
11 | */
12 | if(!('ontouchstart' in window)) return;
13 |
14 | var lastClick = {},
15 | isThresholdReached, touchstart, touchmove, touchend,
16 | click, closest;
17 |
18 | /**
19 | * isThresholdReached
20 | *
21 | * Compare touchstart with touchend xy coordinates,
22 | * and only fire simulated click event if the coordinates
23 | * are nearby. (don't want clicking to be confused with a swipe)
24 | */
25 | isThresholdReached = function(startXY, xy) {
26 | return Math.abs(startXY[0] - xy[0]) > 5 || Math.abs(startXY[1] - xy[1]) > 5;
27 | };
28 |
29 | /**
30 | * touchstart
31 | *
32 | * Save xy coordinates when the user starts touching the screen
33 | */
34 | touchstart = function(e) {
35 | this.startXY = [e.touches[0].clientX, e.touches[0].clientY];
36 | this.threshold = false;
37 | };
38 |
39 | /**
40 | * touchmove
41 | *
42 | * Check if the user is scrolling past the threshold.
43 | * Have to check here because touchend will not always fire
44 | * on some tested devices (Kindle Fire?)
45 | */
46 | touchmove = function(e) {
47 | // NOOP if the threshold has already been reached
48 | if(this.threshold) return false;
49 |
50 | this.threshold = isThresholdReached(this.startXY, [e.touches[0].clientX, e.touches[0].clientY]);
51 | };
52 |
53 | /**
54 | * touchend
55 | *
56 | * If the user didn't scroll past the threshold between
57 | * touchstart and touchend, fire a simulated click.
58 | *
59 | * (This will fire before a native click)
60 | */
61 | touchend = function(e) {
62 | // Don't fire a click if the user scrolled past the threshold
63 | if(this.threshold || isThresholdReached(this.startXY, [e.changedTouches[0].clientX, e.changedTouches[0].clientY])) {
64 | return;
65 | }
66 |
67 | /**
68 | * Create and fire a click event on the target element
69 | * https://developer.mozilla.org/en/DOM/event.initMouseEvent
70 | */
71 | var touch = e.changedTouches[0],
72 | evt = document.createEvent('MouseEvents');
73 | evt.initMouseEvent('click', true, true, window, 0, touch.screenX, touch.screenY, touch.clientX, touch.clientY, false, false, false, false, 0, null);
74 | evt.simulated = true; // distinguish from a normal (nonsimulated) click
75 | e.target.dispatchEvent(evt);
76 | };
77 |
78 | /**
79 | * click
80 | *
81 | * Because we've already fired a click event in touchend,
82 | * we need to listed for all native click events here
83 | * and suppress them as necessary.
84 | */
85 | click = function(e) {
86 | /**
87 | * Prevent ghost clicks by only allowing clicks we created
88 | * in the click event we fired (look for e.simulated)
89 | */
90 | var time = Date.now(),
91 | timeDiff = time - lastClick.time,
92 | x = e.clientX,
93 | y = e.clientY,
94 | xyDiff = [Math.abs(lastClick.x - x), Math.abs(lastClick.y - y)],
95 | target = closest(e.target, 'A') || e.target, // needed for standalone apps
96 | nodeName = target.nodeName,
97 | isLink = nodeName === 'A',
98 | standAlone = window.navigator.standalone && isLink && e.target.getAttribute("href");
99 |
100 | lastClick.time = time;
101 | lastClick.x = x;
102 | lastClick.y = y;
103 |
104 | /**
105 | * Unfortunately Android sometimes fires click events without touch events (seen on Kindle Fire),
106 | * so we have to add more logic to determine the time of the last click. Not perfect...
107 | *
108 | * Older, simpler check: if((!e.simulated) || standAlone)
109 | */
110 | if((!e.simulated && (timeDiff < 500 || (timeDiff < 1500 && xyDiff[0] < 50 && xyDiff[1] < 50))) || standAlone) {
111 | e.preventDefault();
112 | e.stopPropagation();
113 | if(!standAlone) return false;
114 | }
115 |
116 | /**
117 | * Special logic for standalone web apps
118 | * See http://stackoverflow.com/questions/2898740/iphone-safari-web-app-opens-links-in-new-window
119 | */
120 | if(standAlone) {
121 | window.location = target.getAttribute("href");
122 | }
123 |
124 | /**
125 | * Add an energize-focus class to the targeted link (mimics :focus behavior)
126 | * TODO: test and/or remove? Does this work?
127 | */
128 | if(!target || !target.classList) return;
129 | target.classList.add("energize-focus");
130 | window.setTimeout(function(){
131 | target.classList.remove("energize-focus");
132 | }, 150);
133 | };
134 |
135 | /**
136 | * closest
137 | * @param {HTMLElement} node current node to start searching from.
138 | * @param {string} tagName the (uppercase) name of the tag you're looking for.
139 | *
140 | * Find the closest ancestor tag of a given node.
141 | *
142 | * Starts at node and goes up the DOM tree looking for a
143 | * matching nodeName, continuing until hitting document.body
144 | */
145 | closest = function(node, tagName){
146 | var curNode = node;
147 |
148 | while(curNode !== document.body) { // go up the dom until we find the tag we're after
149 | if(!curNode || curNode.nodeName === tagName) { return curNode; } // found
150 | curNode = curNode.parentNode; // not found, so keep going up
151 | }
152 |
153 | return null; // not found
154 | };
155 |
156 | /**
157 | * Add all delegated event listeners
158 | *
159 | * All the events we care about bubble up to document,
160 | * so we can take advantage of event delegation.
161 | *
162 | * Note: no need to wait for DOMContentLoaded here
163 | */
164 | document.addEventListener('touchstart', touchstart, false);
165 | document.addEventListener('touchmove', touchmove, false);
166 | document.addEventListener('touchend', touchend, false);
167 | document.addEventListener('click', click, true); // TODO: why does this use capture?
168 |
169 | })();
--------------------------------------------------------------------------------
/source/javascripts/lib/_imagesloaded.min.js:
--------------------------------------------------------------------------------
1 | /*!
2 | * imagesLoaded PACKAGED v3.1.8
3 | * JavaScript is all like "You images are done yet or what?"
4 | * MIT License
5 | */
6 |
7 | (function(){function e(){}function t(e,t){for(var n=e.length;n--;)if(e[n].listener===t)return n;return-1}function n(e){return function(){return this[e].apply(this,arguments)}}var i=e.prototype,r=this,o=r.EventEmitter;i.getListeners=function(e){var t,n,i=this._getEvents();if("object"==typeof e){t={};for(n in i)i.hasOwnProperty(n)&&e.test(n)&&(t[n]=i[n])}else t=i[e]||(i[e]=[]);return t},i.flattenListeners=function(e){var t,n=[];for(t=0;e.length>t;t+=1)n.push(e[t].listener);return n},i.getListenersAsObject=function(e){var t,n=this.getListeners(e);return n instanceof Array&&(t={},t[e]=n),t||n},i.addListener=function(e,n){var i,r=this.getListenersAsObject(e),o="object"==typeof n;for(i in r)r.hasOwnProperty(i)&&-1===t(r[i],n)&&r[i].push(o?n:{listener:n,once:!1});return this},i.on=n("addListener"),i.addOnceListener=function(e,t){return this.addListener(e,{listener:t,once:!0})},i.once=n("addOnceListener"),i.defineEvent=function(e){return this.getListeners(e),this},i.defineEvents=function(e){for(var t=0;e.length>t;t+=1)this.defineEvent(e[t]);return this},i.removeListener=function(e,n){var i,r,o=this.getListenersAsObject(e);for(r in o)o.hasOwnProperty(r)&&(i=t(o[r],n),-1!==i&&o[r].splice(i,1));return this},i.off=n("removeListener"),i.addListeners=function(e,t){return this.manipulateListeners(!1,e,t)},i.removeListeners=function(e,t){return this.manipulateListeners(!0,e,t)},i.manipulateListeners=function(e,t,n){var i,r,o=e?this.removeListener:this.addListener,s=e?this.removeListeners:this.addListeners;if("object"!=typeof t||t instanceof RegExp)for(i=n.length;i--;)o.call(this,t,n[i]);else for(i in t)t.hasOwnProperty(i)&&(r=t[i])&&("function"==typeof r?o.call(this,i,r):s.call(this,i,r));return this},i.removeEvent=function(e){var t,n=typeof e,i=this._getEvents();if("string"===n)delete i[e];else if("object"===n)for(t in i)i.hasOwnProperty(t)&&e.test(t)&&delete i[t];else delete this._events;return this},i.removeAllListeners=n("removeEvent"),i.emitEvent=function(e,t){var n,i,r,o,s=this.getListenersAsObject(e);for(r in s)if(s.hasOwnProperty(r))for(i=s[r].length;i--;)n=s[r][i],n.once===!0&&this.removeListener(e,n.listener),o=n.listener.apply(this,t||[]),o===this._getOnceReturnValue()&&this.removeListener(e,n.listener);return this},i.trigger=n("emitEvent"),i.emit=function(e){var t=Array.prototype.slice.call(arguments,1);return this.emitEvent(e,t)},i.setOnceReturnValue=function(e){return this._onceReturnValue=e,this},i._getOnceReturnValue=function(){return this.hasOwnProperty("_onceReturnValue")?this._onceReturnValue:!0},i._getEvents=function(){return this._events||(this._events={})},e.noConflict=function(){return r.EventEmitter=o,e},"function"==typeof define&&define.amd?define("eventEmitter/EventEmitter",[],function(){return e}):"object"==typeof module&&module.exports?module.exports=e:this.EventEmitter=e}).call(this),function(e){function t(t){var n=e.event;return n.target=n.target||n.srcElement||t,n}var n=document.documentElement,i=function(){};n.addEventListener?i=function(e,t,n){e.addEventListener(t,n,!1)}:n.attachEvent&&(i=function(e,n,i){e[n+i]=i.handleEvent?function(){var n=t(e);i.handleEvent.call(i,n)}:function(){var n=t(e);i.call(e,n)},e.attachEvent("on"+n,e[n+i])});var r=function(){};n.removeEventListener?r=function(e,t,n){e.removeEventListener(t,n,!1)}:n.detachEvent&&(r=function(e,t,n){e.detachEvent("on"+t,e[t+n]);try{delete e[t+n]}catch(i){e[t+n]=void 0}});var o={bind:i,unbind:r};"function"==typeof define&&define.amd?define("eventie/eventie",o):e.eventie=o}(this),function(e,t){"function"==typeof define&&define.amd?define(["eventEmitter/EventEmitter","eventie/eventie"],function(n,i){return t(e,n,i)}):"object"==typeof exports?module.exports=t(e,require("wolfy87-eventemitter"),require("eventie")):e.imagesLoaded=t(e,e.EventEmitter,e.eventie)}(window,function(e,t,n){function i(e,t){for(var n in t)e[n]=t[n];return e}function r(e){return"[object Array]"===d.call(e)}function o(e){var t=[];if(r(e))t=e;else if("number"==typeof e.length)for(var n=0,i=e.length;i>n;n++)t.push(e[n]);else t.push(e);return t}function s(e,t,n){if(!(this instanceof s))return new s(e,t);"string"==typeof e&&(e=document.querySelectorAll(e)),this.elements=o(e),this.options=i({},this.options),"function"==typeof t?n=t:i(this.options,t),n&&this.on("always",n),this.getImages(),a&&(this.jqDeferred=new a.Deferred);var r=this;setTimeout(function(){r.check()})}function f(e){this.img=e}function c(e){this.src=e,v[e]=this}var a=e.jQuery,u=e.console,h=u!==void 0,d=Object.prototype.toString;s.prototype=new t,s.prototype.options={},s.prototype.getImages=function(){this.images=[];for(var e=0,t=this.elements.length;t>e;e++){var n=this.elements[e];"IMG"===n.nodeName&&this.addImage(n);var i=n.nodeType;if(i&&(1===i||9===i||11===i))for(var r=n.querySelectorAll("img"),o=0,s=r.length;s>o;o++){var f=r[o];this.addImage(f)}}},s.prototype.addImage=function(e){var t=new f(e);this.images.push(t)},s.prototype.check=function(){function e(e,r){return t.options.debug&&h&&u.log("confirm",e,r),t.progress(e),n++,n===i&&t.complete(),!0}var t=this,n=0,i=this.images.length;if(this.hasAnyBroken=!1,!i)return this.complete(),void 0;for(var r=0;i>r;r++){var o=this.images[r];o.on("confirm",e),o.check()}},s.prototype.progress=function(e){this.hasAnyBroken=this.hasAnyBroken||!e.isLoaded;var t=this;setTimeout(function(){t.emit("progress",t,e),t.jqDeferred&&t.jqDeferred.notify&&t.jqDeferred.notify(t,e)})},s.prototype.complete=function(){var e=this.hasAnyBroken?"fail":"done";this.isComplete=!0;var t=this;setTimeout(function(){if(t.emit(e,t),t.emit("always",t),t.jqDeferred){var n=t.hasAnyBroken?"reject":"resolve";t.jqDeferred[n](t)}})},a&&(a.fn.imagesLoaded=function(e,t){var n=new s(this,e,t);return n.jqDeferred.promise(a(this))}),f.prototype=new t,f.prototype.check=function(){var e=v[this.img.src]||new c(this.img.src);if(e.isConfirmed)return this.confirm(e.isLoaded,"cached was confirmed"),void 0;if(this.img.complete&&void 0!==this.img.naturalWidth)return this.confirm(0!==this.img.naturalWidth,"naturalWidth"),void 0;var t=this;e.on("confirm",function(e,n){return t.confirm(e.isLoaded,n),!0}),e.check()},f.prototype.confirm=function(e,t){this.isLoaded=e,this.emit("confirm",this,t)};var v={};return c.prototype=new t,c.prototype.check=function(){if(!this.isChecked){var e=new Image;n.bind(e,"load",this),n.bind(e,"error",this),e.src=this.src,this.isChecked=!0}},c.prototype.handleEvent=function(e){var t="on"+e.type;this[t]&&this[t](e)},c.prototype.onload=function(e){this.confirm(!0,"onload"),this.unbindProxyEvents(e)},c.prototype.onerror=function(e){this.confirm(!1,"onerror"),this.unbindProxyEvents(e)},c.prototype.confirm=function(e,t){this.isConfirmed=!0,this.isLoaded=e,this.emit("confirm",this,t)},c.prototype.unbindProxyEvents=function(e){n.unbind(e.target,"load",this),n.unbind(e.target,"error",this)},s});
--------------------------------------------------------------------------------
/source/javascripts/lib/_jquery.highlight.js:
--------------------------------------------------------------------------------
1 | /*
2 | * jQuery Highlight plugin
3 | *
4 | * Based on highlight v3 by Johann Burkard
5 | * http://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html
6 | *
7 | * Code a little bit refactored and cleaned (in my humble opinion).
8 | * Most important changes:
9 | * - has an option to highlight only entire words (wordsOnly - false by default),
10 | * - has an option to be case sensitive (caseSensitive - false by default)
11 | * - highlight element tag and class names can be specified in options
12 | *
13 | * Usage:
14 | * // wrap every occurrance of text 'lorem' in content
15 | * // with (default options)
16 | * $('#content').highlight('lorem');
17 | *
18 | * // search for and highlight more terms at once
19 | * // so you can save some time on traversing DOM
20 | * $('#content').highlight(['lorem', 'ipsum']);
21 | * $('#content').highlight('lorem ipsum');
22 | *
23 | * // search only for entire word 'lorem'
24 | * $('#content').highlight('lorem', { wordsOnly: true });
25 | *
26 | * // don't ignore case during search of term 'lorem'
27 | * $('#content').highlight('lorem', { caseSensitive: true });
28 | *
29 | * // wrap every occurrance of term 'ipsum' in content
30 | * // with
31 | * $('#content').highlight('ipsum', { element: 'em', className: 'important' });
32 | *
33 | * // remove default highlight
34 | * $('#content').unhighlight();
35 | *
36 | * // remove custom highlight
37 | * $('#content').unhighlight({ element: 'em', className: 'important' });
38 | *
39 | *
40 | * Copyright (c) 2009 Bartek Szopka
41 | *
42 | * Licensed under MIT license.
43 | *
44 | */
45 |
46 | jQuery.extend({
47 | highlight: function (node, re, nodeName, className) {
48 | if (node.nodeType === 3) {
49 | var match = node.data.match(re);
50 | if (match) {
51 | var highlight = document.createElement(nodeName || 'span');
52 | highlight.className = className || 'highlight';
53 | var wordNode = node.splitText(match.index);
54 | wordNode.splitText(match[0].length);
55 | var wordClone = wordNode.cloneNode(true);
56 | highlight.appendChild(wordClone);
57 | wordNode.parentNode.replaceChild(highlight, wordNode);
58 | return 1; //skip added node in parent
59 | }
60 | } else if ((node.nodeType === 1 && node.childNodes) && // only element nodes that have children
61 | !/(script|style)/i.test(node.tagName) && // ignore script and style nodes
62 | !(node.tagName === nodeName.toUpperCase() && node.className === className)) { // skip if already highlighted
63 | for (var i = 0; i < node.childNodes.length; i++) {
64 | i += jQuery.highlight(node.childNodes[i], re, nodeName, className);
65 | }
66 | }
67 | return 0;
68 | }
69 | });
70 |
71 | jQuery.fn.unhighlight = function (options) {
72 | var settings = { className: 'highlight', element: 'span' };
73 | jQuery.extend(settings, options);
74 |
75 | return this.find(settings.element + "." + settings.className).each(function () {
76 | var parent = this.parentNode;
77 | parent.replaceChild(this.firstChild, this);
78 | parent.normalize();
79 | }).end();
80 | };
81 |
82 | jQuery.fn.highlight = function (words, options) {
83 | var settings = { className: 'highlight', element: 'span', caseSensitive: false, wordsOnly: false };
84 | jQuery.extend(settings, options);
85 |
86 | if (words.constructor === String) {
87 | words = [words];
88 | }
89 | words = jQuery.grep(words, function(word, i){
90 | return word != '';
91 | });
92 | words = jQuery.map(words, function(word, i) {
93 | return word.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
94 | });
95 | if (words.length == 0) { return this; };
96 |
97 | var flag = settings.caseSensitive ? "" : "i";
98 | var pattern = "(" + words.join("|") + ")";
99 | if (settings.wordsOnly) {
100 | pattern = "\\b" + pattern + "\\b";
101 | }
102 | var re = new RegExp(pattern, flag);
103 |
104 | return this.each(function () {
105 | jQuery.highlight(this, re, settings.element, settings.className);
106 | });
107 | };
108 |
109 |
--------------------------------------------------------------------------------
/source/layouts/layout.erb:
--------------------------------------------------------------------------------
1 | <%#
2 | Copyright 2008-2013 Concur Technologies, Inc.
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License"); you may
5 | not use this file except in compliance with the License. You may obtain
6 | a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 | License for the specific language governing permissions and limitations
14 | under the License.
15 | %>
16 | <% language_tabs = current_page.data.language_tabs || [] %>
17 | <% page_content = yield %>
18 | <%
19 | if current_page.data.includes
20 | current_page.data.includes.each do |include|
21 | page_content += partial("includes/#{include}")
22 | end
23 | end
24 | %>
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
-
79 | <%= h1[:content] %>
80 | <% if h1[:children].length > 0 %>
81 |
-
82 | <% h1[:children].each do |h2| %>
83 |
- 84 | <%= h2[:content] %> 85 | 86 | <% end %> 87 |
90 | <% end %>
91 |
58 | <%= image_tag "logo.png", class: 'logo' %>
59 | <% if language_tabs.any? %>
60 |
100 |
61 | <% language_tabs.each do |lang| %>
62 | <% if lang.is_a? Hash %>
63 | <%= lang.values.first %>
64 | <% else %>
65 | <%= lang %>
66 | <% end %>
67 | <% end %>
68 |
69 | <% end %>
70 | <% if current_page.data.search %>
71 |
72 |
73 |
74 |
77 | <% toc_data(page_content).each do |h1| %>
78 |
92 | <% if current_page.data.toc_footers %>
93 |
98 | <% end %>
99 |
101 |
102 |
119 |
120 |
121 |
--------------------------------------------------------------------------------
/source/protocols/car-parking/index.html.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Car Parking
3 |
4 | language_tabs: # must be one of https://git.io/vQNgJ
5 | - shell
6 | - javascript
7 | - python
8 |
9 | toc_footers:
10 | - Documentation powered by Slate.
11 |
12 | search: true
13 | ---
14 |
15 |
103 | <%= page_content %>
104 |
105 |
106 | <% if language_tabs.any? %>
107 |
118 |
108 | <% language_tabs.each do |lang| %>
109 | <% if lang.is_a? Hash %>
110 | <%= lang.values.first %>
111 | <% else %>
112 | <%= lang %>
113 | <% end %>
114 | <% end %>
115 |
116 | <% end %>
117 | 
197 | start_at
198 | optional
199 | |
200 | The time at which the requester would like to arrive at the parking space (if undefined, the arrival time will be ASAP). Specified as time in seconds since Epoch/Unix Time | 201 |
204 | end_at
205 | optional
206 | |
207 | The time at which the requester plans to leave the parking space. This parameter is optional but highly recommended, as it can affect how the service is priced. Specified as time in seconds since Epoch/Unix Time | 208 |
211 | latitude
212 | required
213 | |
214 | The latitude coordinate around which to search | 215 |
218 | longitude
219 | required
220 | |
221 | The longitude coordinate around which to search | 222 |
225 | radius
226 | required
227 | |
228 | Radius in meters around the search coordinates to limit the search to. Specified as an integer | 229 |
232 | height
233 | optional
234 | |
235 | The minimum height clearance that this vehicle requires from the parking space. Specified as an integer representing centimeters | 236 |
239 | width
240 | optional
241 | |
242 | The minimum width clearance that this vehicle requires from the parking space. Specified as an integer representing centimeters | 243 |
246 | length
247 | optional
248 | |
249 | The minimum length clearance that this vehicle requires from the parking space. Specified as an integer representing centimeters | 250 |
253 | weight
254 | optional
255 | |
256 | The weight of this vehicle. Parking spaces that cannot support a vehicle weighing this much should not respond. Specified as an integer representing kilograms | 257 |
260 | amenities
261 | optional
262 | |
263 | A list of amenities that need to be present at the parking space. Specified as a comma separated list of amenity IDs. See Amenities | 264 |
385 | need_id
386 | required
387 | |
388 | The unique identifier of the 'need' this bid is for. This ID arrives as part of the 'need' request | 389 |
392 | expires_at
393 | required
394 | |
395 | This bid will expire at this time. Specified as time in seconds since Epoch/Unix Time | 396 |
399 | price
400 | required
401 | |
402 | A comma separated list of prices. Each price is specified as an integer representing Vinci
403 | 1 DAV == 1e18 Vinci == 1000000000000000000 Vinci |
404 |
407 | price_type
408 | required
409 | |
410 | A list of price types describing the price parameter(s). Specified as a comma separated list. See Price Types for available values |
411 |
414 | price_description
415 | required
416 | |
417 | A comma separated list of strings describing the price parameter(s) in human readable terms |
418 |
421 | latitude
422 | required
423 | |
424 | The latitude coordinate of the parking space | 425 |
428 | longitude
429 | required
430 | |
431 | The longitude coordinate of the parking space | 432 |
435 | entrance_latitude
436 | optional
437 | |
438 | The latitude coordinate of the entrance to the parking space | 439 |
442 | entrance_longitude
443 | optional
444 | |
445 | The longitude coordinate of the entrance to the parking space | 446 |
449 | exit_latitude
450 | optional
451 | |
452 | The latitude coordinate of the exit from the parking space | 453 |
456 | exit_longitude
457 | optional
458 | |
459 | The longitude coordinate of the exit from the parking space | 460 |
463 | location_floor
464 | optional
465 | |
466 | Which floor/level is the parking space located on (for multistory buildings) | 467 |
470 | location_name
471 | optional
472 | |
473 | A human readable name/description of the parking space location (e.g., Long Island Central Parking Lot) | 474 |
477 | location_name_lang
478 | optional
479 | |
480 | The language used in location_name. Specified using the 3 letter ISO 639-3 language code |
481 |
484 | location_house_number
485 | optional
486 | |
487 | The house number where the parking space is located | 488 |
491 | location_street
492 | optional
493 | |
494 | The street name where the parking space is located | 495 |
498 | location_city
499 | optional
500 | |
501 | The city where the parking space is located | 502 |
505 | location_postal_code
506 | optional
507 | |
508 | The postal code where the parking space is located | 509 |
512 | location_county
513 | optional
514 | |
515 | The county where the parking space is located | 516 |
519 | location_state
520 | optional
521 | |
522 | The state where the parking space is located | 523 |
526 | location_country
527 | optional
528 | |
529 | The country where the parking space is located | 530 |
533 | available_from
534 | required
535 | |
536 | The time from which the parking space can be made available. Specified as time in seconds since Epoch/Unix Time | 537 |
540 | available_until
541 | required
542 | |
543 | The time until which the parking space can be made available. Specified as time in seconds since Epoch/Unix Time | 544 |
547 | height
548 | optional
549 | |
550 | The maximum vehicle height this parking space can accommodate. Specified as an integer representing centimeters | 551 |
554 | width
555 | optional
556 | |
557 | The maximum vehicle width this parking space can accommodate. Specified as an integer representing centimeters | 558 |
561 | length
562 | optional
563 | |
564 | The maximum vehicle length this parking space can accommodate. Specified as an integer representing centimeters | 565 |
568 | weight
569 | optional
570 | |
571 | The maximum vehicle weight this parking space can accommodate. Specified as an integer representing kilograms | 572 |
575 | amenities
576 | optional
577 | |
578 | A list of amenities that are present at this parking space. Specified as a comma separated list of amenity IDs. See Amenities | 579 |
| Price Type | 589 |Description | 590 |
|---|---|
second |
593 | Cost per second | 594 |
minute |
597 | Cost per minute | 598 |
hour |
601 | Cost per hour | 602 |
day |
605 | Cost per day | 606 |
week |
609 | Cost per week | 610 |
flat |
613 | The listed price is a flat price |
614 |
| ID | 624 |Description | 625 |
|---|---|
1 |
628 | Lodging | 629 |
2 |
632 | Dining | 633 |
3 |
636 | Restrooms | 637 |
4 |
640 | EV Charging | 641 |
5 |
644 | Valet Parking | 645 |
6 |
648 | WiFi | 649 |
7 |
652 | Shopping | 653 |
8 |
656 | Grocery | 657 |
195 | start_at
196 | optional
197 | |
198 | The earliest time at which the photo shoot can start (if undefined, photo shoot can start immediately). Specified as time in seconds since Epoch/Unix Time | 199 |
202 | end_at
203 | required
204 | |
205 | The latest time at which the photo shoot should end. Specified as time in seconds since Epoch/Unix Time | 206 |
209 | object_latitude
210 | required
211 | |
212 | The latitude coordinate of the object that needs to be photographed | 213 |
216 | object_longitude
217 | required
218 | |
219 | The longitude coordinate of the object that needs to be photographed | 220 |
223 | object_altitude
224 | required
225 | |
226 | The altitude of the object that needs to be photographed. Specified as meters above sea level. For example, if the object is located 50 meters above sea level, the object_altitude will be 50 |
227 |
230 | azimuth_angle
231 | required
232 | |
233 | The horizontal angle of the camera pointing at the object. Specified as an integer representing degrees. For example, if the camera should be directly south of the photographed object, the azimuth_angle will be 0 |
234 |
237 | elevation_angle
238 | required
239 | |
240 | The vertical angle of the camera pointing at the object. Specified as an integer representing degrees, positive above the horizon, and negative below the horizon. For example, to photograph a rooftop from above, the elevation_angle might be -90 |
241 |
244 | distance
245 | required
246 | |
247 | The distance of the camera from the photographed object. Specified as an integer representing meters | 248 |
251 | min_resolution
252 | optional
253 | |
254 | The minimum required dimensions for the photos. Specified as integers representing pixels, in a comma separated list of two integers (e.g., 1366,768 for HD photos) |
255 |
322 | need_id
323 | required
324 | |
325 | The unique identifier of the 'need' this bid is for. This ID arrives as part of the 'need' request | 326 |
329 | expires_at
330 | required
331 | |
332 | This bid will expire at this time. Specified as time in seconds since Epoch/Unix Time | 333 |
336 | price
337 | required
338 | |
339 | A comma separated list of prices. Each price is specified as an integer representing Vinci
340 | 1 DAV == 1e18 Vinci == 1000000000000000000 Vinci |
341 |
344 | price_type
345 | required
346 | |
347 | A list of price types describing the price parameter(s). Specified as a comma separated list. Currently the only supported price type is flat |
348 |
351 | price_description
352 | required
353 | |
354 | A comma separated list of strings describing the price parameter(s) in human readable terms |
355 |
358 | eta
359 | required
360 | |
361 | The estimated time of arrival at the photo shoot location. Specified as time in seconds since Epoch/Unix Time | 362 |
365 | camera_model
366 | required
367 | |
368 | A human readable name/description of the camera used for the photo shooting (e.g., DJI ZENMUSE X5S) |
369 |
372 | photo_resolution
373 | required
374 | |
375 | The dimensions of the photos that will be taken. Specified as integers representing pixels, in a comma separated list of two integers (e.g., 1366,768 for HD photos) |
376 |
379 | camera_operator
380 | required
381 | |
382 | The operator of the camera during the photo shoot (e.g., human, drone) See full list of options here |
383 |
387 | operator_model
388 | optional
389 | |
390 | A human readable name/description of the vehicle that may be used to carry the camera and perform the photo shoot (e.g., DJI Matrice 210) |
391 |
| Camera Operator | 401 |Description | 402 |
|---|---|
handheld |
405 | Good ol' human photographer | 406 |
uav |
409 | Unmanned aerial vehicle, commonly known as a drone. An aircraft without a human pilot aboard | 410 |
usv |
413 | Unmanned surface vehicle. A vehicle that operates on the surface of the water (watercraft) without a crew 414 | | 415 |
uuv |
418 | Unmanned underwater vehicle, sometimes known as underwater drones. Any vehicles that are able to operate underwater without a human occupant 419 | | 420 |
ugv |
423 | Unmanned ground vehicle. A vehicle that operates while in contact with the ground and without an on board human presence 424 | | 425 |
183 | start_at
184 | optional
185 | |
186 | 187 | The time at which the requester would like to start the trip (if undefined, start time will be set by the route planner). This should be Specified as time in seconds since Epoch/Unix Time 188 | | 189 |
192 | start_latitude
193 | required
194 | |
195 | The latitude coordinate of the starting point, from where the vehicle plans to start the trip | 196 |
199 | start_longitude
200 | required
201 | |
202 | The longitude coordinate of the starting point, from where the vehicle plans start the trip | 203 |
206 | end_latitude
207 | required
208 | |
209 | The latitude coordinate of the ending point, where the vehicle plans end the trip | 210 |
213 | end_longitude
214 | required
215 | |
216 | The longitude coordinate of the ending point, where the vehicle plans end the trip | 217 |
220 | vehicle_type
221 | required
222 | |
223 | The type of vehicle used for the trip. See full list of options here 224 | | 225 |
228 | max_altitude
229 | optional
230 | |
231 | In case the vehicle is a drone, max_altitude represents the maximum reachable altitude of the drone. Specified as an integer representing meters
232 | |
233 |
236 | height
237 | optional
238 | |
239 | The height of the vehicle. Specified as an integer representing centimeters | 240 |
243 | width
244 | optional
245 | |
246 | The width of the vehicle. Specified as an integer representing centimeters | 247 |
250 | length
251 | optional
252 | |
253 | The length of the vehicle. Specified as an integer representing centimeters | 254 |
257 | weight
258 | optional
259 | |
260 | The weight of the vehicle. Specified as an integer representing kilograms | 261 |
316 | need_id
317 | required
318 | |
319 | The unique identifier of the 'need' this bid is for. This ID arrives as part of the 'need' request | 320 |
323 | expires_at
324 | required
325 | |
326 | This bid will expire at this time. Specified as time in seconds since Epoch/Unix Time | 327 |
330 | price
331 | required
332 | |
333 | A comma separated list of prices. Each price is specified as an integer representing Vinci
334 | 1 DAV == 1e18 Vinci == 1000000000000000000 Vinci |
335 |
338 | price_type
339 | required
340 | |
341 | A list of price types describing the price parameter(s). Specified as a comma separated list. See Price Types for available values |
342 |
345 | price_description
346 | required
347 | |
348 | A comma separated list of strings describing the price parameter(s) in human readable terms |
349 |
352 | eta
353 | required
354 | |
355 | The estimated time of when the route plan will be delivered. Specified as time in seconds since Epoch/Unix Time | 356 |
| Vehicle Type | 366 |
|---|
drone |
369 |
car |
372 |
truck |
375 |
van |
378 |
ship |
381 |
robot |
384 |
bike |
387 |
| Price Type | 397 |Description | 398 |
|---|---|
km |
401 | The listed price is per km |
402 |
mile |
405 | The listed price is per mile |
406 |
flat |
409 | The listed price is a flat price |
410 |
189 | last_latitude
190 | required
191 | |
192 | The last recorded latitude coordinate of the lost vehicle | 193 |
196 | last_longitude
197 | required
198 | |
199 | The last recorded longitude coordinate of the lost vehicle | 200 |
203 | vehicle_type
204 | required
205 | |
206 | The type of vehicle that was lost. See full list of options here | 207 |
211 | vehicle_manufacturer
212 | required
213 | |
214 | Name of the manufacturer of the lost vehicle | 215 |
218 | vehicle_model
219 | required
220 | |
221 | Name of the model of the lost vehicle | 222 |
225 | vehicle_color
226 | optional
227 | |
228 | The color of the lost vehicle | 229 |
232 | vehicle_license_number
233 | optional
234 | |
235 | The license plate number of the lost vehicle | 236 |
239 | vehicle_contact
240 | optional
241 | |
242 | Human readable information regarding the lost vehicle (e.g., Vehicle owner: James McGill, mobile: 555-338-5943) |
243 |
317 | need_id
318 | required
319 | |
320 | The unique identifier of the 'need' this bid is for. This ID arrives as part of the 'need' request | 321 |
324 | expires_at
325 | required
326 | |
327 | This bid will expire at this time. Specified as time in seconds since Epoch/Unix Time | 328 |
331 | price
332 | required
333 | |
334 | A comma separated list of prices. Each price is specified as an integer representing Vinci
335 | 1 DAV == 1e18 Vinci == 1000000000000000000 Vinci |
336 |
339 | price_type
340 | required
341 | |
342 | A list of price types describing the price parameter(s). Specified as a comma separated list. See Price Types for available values |
343 |
346 | price_description
347 | required
348 | |
349 | A comma separated list of strings describing the price parameter(s) in human readable terms |
350 |
353 | current_latitude
354 | required
355 | |
356 | The latitude coordinate of of where the vehicle is currently located | 357 |
360 | current_longitude
361 | required
362 | |
363 | The longitude coordinate of where the vehicle is currently located | 364 |
367 | arrival_at
368 | required
369 | |
370 | The estimated time of arrival at the location where the lost vehicle was last seen. Specified as time in seconds since Epoch/Unix Time | 371 |
374 | vehicle_type
375 | required
376 | |
377 | The type of vehicle used for the locating mission. See full list of options here 378 | | 379 |
382 | vehicle_manufacturer
383 | optional
384 | |
385 | Name of the manufacturer of the vehicle | 386 |
389 | vehicle_model
390 | optional
391 | |
392 | Name of the model of the vehicle | 393 |
396 | vehicle_contact
397 | optional
398 | |
399 | Human readable information regarding the vehicle (e.g James McGill, mobile: 555-338-5943) |
400 |
| Vehicle Type | 410 |
|---|
drone |
413 |
car |
416 |
truck |
419 |
van |
422 |
ship |
425 |
robot |
428 |
bike |
431 |
| Price Type | 441 |Description | 442 |
|---|---|
second |
445 | Cost per second | 446 |
minute |
449 | Cost per minute | 450 |
hour |
453 | Cost per hour | 454 |
day |
457 | Cost per day | 458 |
week |
461 | Cost per week | 462 |
km |
465 | Cost per km | 466 |
mile |
469 | Cost per mile | 470 |
flat |
473 | The listed price is a flat price |
474 |
95 | location
96 | required
97 | |
98 | The coordinates around which to search | 99 |
102 | radius
103 | required
104 | |
105 | Radius in meters around the coordinates in which to listen for bids. Specified as an integer | 106 |
109 | startAt
110 | optional
111 | |
112 | The time at which the requester would like to arrive at charger (if undefined, the arrival time will be ASAP). Specified as time in seconds since Epoch/Unix Time | 113 |
116 | dimensions
117 | optional
118 | |
119 | The minimum length, width, and height clearance that this vessel requires from the charger. Specified as an object containing integers representing centimeters | 120 |
123 | weight
124 | optional
125 | |
126 | The weight of this vessel. Specified as an integer representing grams | 127 |
130 | batteryCapacity
131 | optional
132 | |
133 | The vessel's total battery capacity, specified in kWh | 134 |
137 | currentBatteryCharge
138 | optional
139 | |
140 | The vessel's current battery charge level, as it was at the time the request was sent. Specified as an integer denoting percentage of full capacity | 141 |
144 | energySource
145 | optional
146 | |
147 | Limit the request to only receive bids from chargers using a specific source of energy. Specified as an energy source id. See Energy Sources | 148 |
151 | amenities
152 | optional
153 | |
154 | A list of amenities that need to be present at charging station. Specified as an array of amenity ids. See Amenities | 155 |
215 | location
216 | required
217 | |
218 | The coordinates around which to listen for bids | 219 |
222 | radius
223 | required
224 | |
225 | Radius in meters around the coordinates in which to listen for bids. Specified as an integer | 226 |
229 | maxDimensions
230 | optional
231 | |
232 | The maximum length, width, and height clearance that this charger can accomodate. Specified as an object containing integers representing centimeters | 233 |
318 | ttl
319 | optional
320 | |
321 | This bid will expire at this time. Specified as time in seconds since Epoch/Unix Time | 322 |
325 | price
326 | required
327 | |
328 | A single price or an array containing prices. If an array is given, all the prices will be charged (e.g., a price per kWh plus a flat rate tax). Each price is specified as either an string representing Vinci, or a price object containing amount, price type, and an optional description
329 | 1 DAV == 1e18 Vinci == 1000000000000000000 Vinci |
330 |
333 | entranceLocation
334 | optional
335 | |
336 | The coordinates of the charger entrance | 337 |
340 | exitLocation
341 | optional
342 | |
343 | The coordinates of the exit from to the charger | 344 |
347 | locationName
348 | optional
349 | |
350 | A human readable name/description of the charger location (e.g., Cal Maritime Dock C) | 351 |
354 | locationNameLang
355 | optional
356 | |
357 | The language used in location_name. Specified using the 3 letter ISO 639-3 language code |
358 |
361 | locationHouseNumber
362 | optional
363 | |
364 | The house number where the station is located | 365 |
368 | locationStreet
369 | optional
370 | |
371 | The street name where the station is located | 372 |
375 | locationCity
376 | optional
377 | |
378 | The city where the station is located | 379 |
382 | locationPostalCode
383 | optional
384 | |
385 | The postal code where the station is located | 386 |
389 | locationCounty
390 | optional
391 | |
392 | The county where the charger is located | 393 |
396 | locationState
397 | optional
398 | |
399 | The state where the charger is located | 400 |
403 | locationCountry
404 | optional
405 | |
406 | The country where the charger is located | 407 |
410 | availableFrom
411 | required
412 | |
413 | The time from which the charger can be made available for the vessel requesting a charge. Specified as time in seconds since Epoch/Unix Time | 414 |
417 | availableUntil
418 | optional
419 | |
420 | The time until which the charger can be made available for the vessel requesting a charge. Specified as time in seconds since Epoch/Unix Time | 421 |
424 | energySource
425 | optional
426 | |
427 | The source of the energy used by this charger. Specified as an energy source id. See Energy Sources | 428 |
431 | amenities
432 | optional
433 | |
434 | A list of amenities that are present at this charger. Specified as an array of amenity ids. See Amenities | 435 |
438 | provider
439 | optional
440 | |
441 | Name of the service provider or charging network operating this charger | 442 |
445 | manufacturer
446 | optional
447 | |
448 | Name of the manufacturer of this charger | 449 |
452 | model
453 | optional
454 | |
455 | Name of the model of this charger | 456 |
| None | 482 |
| None | 508 |
538 | chargeCompletionEstimatedTime
539 | optional
540 | |
541 | The estimated time at which charging will be complete. Specified as time in seconds since Epoch/Unix Time | 542 |
578 | location
579 | optional
580 | |
581 | The current coordinates of the vehicle's location | 582 |
| None | 608 |
| None | 634 |
| None | 662 |
| Level | 672 |Description | 673 |
|---|---|
grid |
676 | Connected to the electrical grid and using an unspecified energy source, or an unspecified mix of energy source | 677 |
renewable |
680 | Uses 100% renewable energy of an unspecified source, or a mix of different renewable energy sources | 681 |
solar |
684 | Uses 100% solar energy | 685 |
wind |
688 | Uses 100% wind energy | 689 |
hydro |
692 | Uses 100% hydro power energy | 693 |
geothermal |
696 | Uses 100% geothermal energy | 697 |
| ID | 707 |Description | 708 |
|---|---|
1 |
711 | Lodging | 712 |
2 |
715 | Dining | 716 |
3 |
719 | Restrooms | 720 |
4 |
723 | Docking | 724 |
5 |
727 | Park | 728 |
6 |
731 | WiFi | 732 |
7 |
735 | Shopping | 736 |
8 |
739 | Grocery | 740 |
| Price Type | 750 |Description | 751 |
|---|---|
kwh |
754 | Cost per kWh | 755 |
second |
758 | Cost per second | 759 |
minute |
762 | Cost per minute | 763 |
hour |
766 | Cost per hour | 767 |
day |
770 | Cost per day | 771 |
week |
774 | Cost per week | 775 |
flat |
778 | The listed price is a flat price |
779 |