From 785f2dde1699e0777d65b64029d2e9a3b47cfc15 Mon Sep 17 00:00:00 2001 From: Dave C-J Date: Wed, 10 Dec 2014 09:30:20 +0000 Subject: [PATCH] Add initial GeoHash node --- parsers/geohash/70-geohash.html | 52 ++++++++++ parsers/geohash/70-geohash.js | 93 +++++++++++++++++ parsers/geohash/LICENSE | 177 ++++++++++++++++++++++++++++++++ parsers/geohash/README.md | 35 +++++++ parsers/geohash/package.json | 24 +++++ 5 files changed, 381 insertions(+) create mode 100644 parsers/geohash/70-geohash.html create mode 100644 parsers/geohash/70-geohash.js create mode 100644 parsers/geohash/LICENSE create mode 100644 parsers/geohash/README.md create mode 100644 parsers/geohash/package.json diff --git a/parsers/geohash/70-geohash.html b/parsers/geohash/70-geohash.html new file mode 100644 index 00000000..1a43fcea --- /dev/null +++ b/parsers/geohash/70-geohash.html @@ -0,0 +1,52 @@ + + + + + + + diff --git a/parsers/geohash/70-geohash.js b/parsers/geohash/70-geohash.js new file mode 100644 index 00000000..24fd95da --- /dev/null +++ b/parsers/geohash/70-geohash.js @@ -0,0 +1,93 @@ +/** + * Copyright 2014 IBM Corp. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + **/ + +module.exports = function(RED) { + "use strict"; + var geohash = require('ngeohash'); + + function GeohashNode(n) { + RED.nodes.createNode(this,n); + var node = this; + + var round = function(value, decimals) { + return Number(Math.round(value+'e'+decimals)+'e-'+decimals); + } + + this.on("input", function(msg) { + if (msg.hasOwnProperty("location")) { + if (msg.location.hasOwnProperty("geohash")) { + var pos = geohash.decode(msg.location.geohash); + msg.location.lat = round(pos.latitude,5); + msg.location.lon = round(pos.longitude,5); + msg.location.error = { lat:round(pos.error.latitude,5), lon:round(pos.error.longitude,5) }; + node.send(msg); + } + else { + var lat = msg.location.lat; + var lon = msg.location.lon; + var len = parseInt(msg.location.precision || msg.location.payload || 9); + if (len < 1) { len = 1; } + if (len > 9) { len = 9; } + if (lat && lon) { + msg.location.geohash = geohash.encode(lat, lon, len); + node.send(msg); + } + } + } + else if (typeof msg.payload === "string") { + // try to decode it... + var regexp = new RegExp('^[a-z0-9]{1,9}$'); // can only contain a-z or 0-9 and length 1-9 + if (regexp.test(msg.payload)) { + var pos = geohash.decode(msg.payload); + msg.payload = { lat:round(pos.latitude,5), lon:round(pos.longitude,5) }; + msg.payload.error = { lat:round(pos.error.latitude,5), lon:round(pos.error.longitude,5) }; + node.send(msg); + } + else if (msg.payload.indexOf(",") !== -1) { + // has a comma so assume it's lat,lon(,precision) + var bits = msg.payload.split(","); + if (bits.length === 2) { + var la = Number(bits[0]); + if (la < -90) { la = -90; } + if (la > 90) { la = 90; } + var lo = Number(bits[1]); + if (lo < -180) { lo = -180; } + if (lo > 180) { la = 180; } + msg.payload = geohash.encode(la, lo); + node.send(msg); + } + else { node.warn("Unexpected string format - should be lat,lon"); } + } + else { node.warn("Unexpected string format - should either be lat,lon or geohash"); } + } + else if (typeof msg.payload === "object") { + var lat = msg.payload.lat || msg.payload.latitude; + var lon = msg.payload.lon || msg.payload.longitude; + var len = parseInt(msg.payload.precision || 9); + if (len < 1) { len = 1; } + if (len > 9) { len = 9; } + if (lat && lon) { + msg.payload.geohash = geohash.encode(lat, lon, len); + node.send(msg); + } + } + else { + node.warn("This node only expects strings or objects."); + } + }); + } + RED.nodes.registerType("geohash",GeohashNode); +} diff --git a/parsers/geohash/LICENSE b/parsers/geohash/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/parsers/geohash/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/parsers/geohash/README.md b/parsers/geohash/README.md new file mode 100644 index 00000000..76fc67f2 --- /dev/null +++ b/parsers/geohash/README.md @@ -0,0 +1,35 @@ +node-red-node-geohash +===================== + +A Node-RED node to encode and decode lat,lon pairs to a geohash string. + +Install +------- + +Run the following command in the root directory of your Node-RED install + + npm install node-red-node-geohash + + +Usage +----- + +This function encodes a lat,lon string to and from a geohash. + +If the **msg.payload** is a string it tries to see if it's a geohash - + if so it tries to decode it and outputs a payload object containing + + - latitude + - longitude + - errorlatitude + - error.longitude + +If the **msg.payload** is an object with properties **lat** or **latitude** and **lon** or **longitude** - it will add a geohash property to the payload. + +The precision can be set by **msg.payload.precision** from 1 to 9. + + +Example flow +------------ + +
[{"id":"60ebfc45.9f1404","type":"function","name":"","func":"msg.payload = {lat:51,lon:-1,precision:5};\nreturn msg;","outputs":1,"x":281,"y":485,"z":"385bdf8b.c7a42","wires":[["6f1c5357.90e3ac"]]},{"id":"6f1c5357.90e3ac","type":"geohash","name":"","x":415.5,"y":420,"z":"385bdf8b.c7a42","wires":[["71a94378.8e56bc"]]},{"id":"52763c46.ad89c4","type":"inject","name":"","topic":"","payload":"51.05,-1.05","payloadType":"string","repeat":"","crontab":"","once":false,"x":165.5,"y":337,"z":"385bdf8b.c7a42","wires":[["7b08247.f84f7dc"]]},{"id":"7b08247.f84f7dc","type":"geohash","name":"","x":360.5,"y":337,"z":"385bdf8b.c7a42","wires":[["6f1c5357.90e3ac","893e37b7.76c1c8"]]},{"id":"6fec77c4.901388","type":"inject","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"x":155,"y":397,"z":"385bdf8b.c7a42","wires":[["60ebfc45.9f1404"]]},{"id":"893e37b7.76c1c8","type":"debug","name":"","active":true,"console":"false","complete":"false","x":535,"y":337,"z":"385bdf8b.c7a42","wires":[]},{"id":"71a94378.8e56bc","type":"debug","name":"","active":true,"console":"false","complete":"false","x":590,"y":420,"z":"385bdf8b.c7a42","wires":[]}]
diff --git a/parsers/geohash/package.json b/parsers/geohash/package.json new file mode 100644 index 00000000..071ee339 --- /dev/null +++ b/parsers/geohash/package.json @@ -0,0 +1,24 @@ +{ + "name" : "node-red-node-geohash", + "version" : "0.0.1", + "description" : "A Node-RED node to encode and decode lat,lon pairs to a geohash.", + "dependencies" : { + "ngeohash" : "0.6.0" + }, + "repository" : { + "type":"git", + "url":"https://github.com/node-red/node-red-nodes/tree/master/parsers/geohash" + }, + "license": "Apache-2.0", + "keywords": [ "node-red", "geohash" ], + "node-red" : { + "nodes" : { + "geohash": "70-geohash.js" + } + }, + "author": { + "name": "Dave Conway-Jones", + "email": "ceejay@vnet.ibm.com", + "url": "http://nodered.org" + } +}