{"_id":"@codekilo/signalk-cloud-transport","_rev":"1-37034b001c6cff984c0b12f120c3b81d","name":"@codekilo/signalk-cloud-transport","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@codekilo/signalk-cloud-transport","version":"1.0.0","description":"transport signalk data to a server in the cloud","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/codekilo/signalk-cloud-transport.git"},"author":{"name":"Albert Smit","email":"albertsmit93@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/codekilo/signalk-cloud-transport/issues"},"bin":{"signalk-cloud-tx":"bin/signalk-cloud-tx","signalk-cloud-rx":"bin/signalk-cloud-rx"},"homepage":"https://github.com/codekilo/signalk-cloud-transport#readme","dependencies":{"config":"^3.2.4","mississippi":"^4.0.0","mqtt":"^3.0.0","stream-from-value":"^0.1.0","stream-meter":"^1.0.4","ws":"^7.2.0"},"gitHead":"1998dc56726cf5efc9c341b86828ed6beb77d2d0","_id":"@codekilo/signalk-cloud-transport@1.0.0","_nodeVersion":"12.16.3","_npmVersion":"6.14.4","dist":{"integrity":"sha512-hfy4DxUDCObCnpfy0N9Wb0ele58Prn+Y/2w5LaHvYvYq6zP7IGG84SbGCIaBp9lwpwbEsSSQ00FSFwPUJGUoSw==","shasum":"367265a6221c01bccd98ce920a9afa8a3fd0e15e","tarball":"https://registry.npmjs.org/@codekilo/signalk-cloud-transport/-/signalk-cloud-transport-1.0.0.tgz","fileCount":12,"unpackedSize":13087,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe6g4VCRA9TVsSAnZWagAAe5oP/2TKlq3CL5Ks75YGSG15\nzPvzek5z58ENS6UrPV4NKfCIZkm9WqNBm6iU50GpaKs7irq9ermmTi4k5A/v\n2KHQHYBZnF+v6nyFpQtcDnIgsMLpfplDMJ5e5kqNRgaaKFoouGiGfKbWVs1l\n1oxSWmDEXeTP69VWYt/xwZ7Bud495y/Gw1KoQaFTtBz0x2LMZrvsxP6Em1cF\njKeSoRxGvAGuTGDRaGMTpZvIvRUKonlqJjebFcYtAZeTv0dcjZWazg+zcSsQ\n2TghRN9FjF0+LlnkzLff0zU1idZ0prL8s9e/+1UBzXcWs0NnpqPHFoJ7bU3O\noPlcU4MzETRHjx8jKKASLWv4lTaZp9gYINZEFPfit/uIfCfskbLVse4GRer/\nR3HbbsdGHbbOwQCTKRcQFji/FAfZXRh2H8Uv7T/qSoMVaFifAYHzCEzgHIWz\n0ET6FAlqm+JByJg2zvl9kT2UDx16KNdfzg3mZtwhwP7wVDUVMUarj1Pbkjwg\nzZVCyAnllgvUUnMhgW9+d8A3v5XJwA0zs1t/SoZMMpoyPCJZ+G8oLvq+s5gF\n7IeeUbJ4ViyUUHe5OO8Q2l7amFse5itPFY50avMaJEGEQXISE8cqpsNr6rBO\nddmobs9vkCYuf9uhuKLMlp8UXlCa1k5dUglECX2lw8Ms35FlXVdZO+78zC+G\nIfNL\r\n=TJD2\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCijqThhYm2JwVR2E3HfeCZjDz9soekU1b4Z07f+rfe8QIhAI7+ElHyA5Tqd0JL7tt5Xj0nalPwLO2QxfqUAWUO1HX8"}]},"maintainers":[{"name":"albert-smit","email":"albertsmit93@gmail.com"},{"name":"munnik","email":"martijndemunnik@protonmail.com"}],"_npmUser":{"name":"albert-smit","email":"albertsmit93@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/signalk-cloud-transport_1.0.0_1592397333010_0.46864543015526006"},"_hasShrinkwrap":false}},"time":{"created":"2020-06-17T12:35:32.746Z","1.0.0":"2020-06-17T12:35:33.123Z","modified":"2022-04-05T00:03:10.803Z"},"maintainers":[{"name":"albert-smit","email":"albertsmit93@gmail.com"},{"name":"munnik","email":"martijndemunnik@protonmail.com"}],"description":"transport signalk data to a server in the cloud","homepage":"https://github.com/codekilo/signalk-cloud-transport#readme","repository":{"type":"git","url":"git+https://github.com/codekilo/signalk-cloud-transport.git"},"author":{"name":"Albert Smit","email":"albertsmit93@gmail.com"},"bugs":{"url":"https://github.com/codekilo/signalk-cloud-transport/issues"},"license":"MIT","readme":"# SignalK cloud transport\n\nThis package is designed to transport signalk messages over mqtt multiple messages are bundled together and then compressed and encrypted.\n\n## Installation\nto install this package run `npm install @codekilo/signalk-cloud-transport`\n\n## Use \n\n### Transmitter\nrun `signalk-cloud-tx` in a directory that also has the `config/` directory\n\n### Receiver\nrun `signalk-cloud-rx` in a directory that also has the `config/` directory. This config file should contain the token for the websocket connection if required.\n\nTo generate a token to connect to a signalk server with security enabled see [the signalK specification](https://signalk.org/specification/1.3.0/doc/access_requests.html).\n\n## Configuration\n\nThe configuration for the transmitter is in `config/transmitter/default.json`. The configuration for the receiver is located in `config/receiver/default.json`.\n\n### Shared\n\nThe following options are shared by both the transmitter and receiver.\n#### ip \nThe IP address of the signalk server.\n#### port\nThe port of the signalk server \n#### mqtttopic\nThe mqtt topic the messages will appear on\n#### mqttbroker\nThe address of the mqtt broker.\n#### password\nthe password to derive the key from.\n\n### Transmitter\n#### buffersize\nThe maximum size of the buffer in bytes, the message will be transmitted when the buffer is full.\n#### period\nThe maximum time between two messages in seconds.\n#### sendothers\nIf true send data about all known vessels, when false only send data about the own vessel.\n#### paths\nAn array of paths to include in messages, paths can inlcude `*` as wildcard.\n\n### Receiver\n#### token\nThe token used to connect to the signalk server (optional). To generate a token see [the signalk documentation](https://signalk.org/specification/1.3.0/doc/access_requests.html#device-requests).\n\n\n## Development\n\nTo install this package for development clone it from git and run npm install, this needs to happen on both the client and the server.\n\n```\ngit clone https://github.com/codekilo/signalk-cloud-transport.git\ncd signalk-cloud-transport\nsudo npm  -g install\n```\n","readmeFilename":"README.md"}