https://github.com/streamr-dev/mqtt-streamr

Command-line utility for bridging data from MQTT to Streamr
https://github.com/streamr-dev/mqtt-streamr

command-line-tool data integration mqtt streamr utility

Last synced: about 2 months ago
JSON representation

Command-line utility for bridging data from MQTT to Streamr

• Host: GitHub
• URL: https://github.com/streamr-dev/mqtt-streamr
• Owner: streamr-dev
• License: agpl-3.0
• Created: 2019-05-24T14:41:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-18T13:49:45.000Z (7 months ago)
• Last Synced: 2024-06-18T16:26:47.593Z (7 months ago)
• Topics: command-line-tool, data, integration, mqtt, streamr, utility
• Language: JavaScript
• Size: 1.64 MB
• Stars: 4
• Watchers: 4
• Forks: 4
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mqtt-streamr

A command line utility for bridging data from a MQTT broker to [Streamr Network](https://streamr.network) with

stream auto-creation and other useful features. This utility is basically a script with a MQTT client and a Streamr light node, and some code to glue the two together.

## Installation

```

npm install -g @streamr/mqtt-streamr

```

## Usage

To get help, including a list of all the command-line options, simply run `mqtt-streamr`.

Minimal usage: `mqtt-streamr --mqtt-url [mqtt-url] --topic [path] --private-key [key]`

## Required options

`--mqtt-url [url]`

The MQTT server URL to connect to, for example `--mqtt-url wss://some-mqtt-server.com`.

`--topic [topic]`

MQTT topic/path to subscribe to. Give this option multiple times to subscribe to several topics.

Can include wildcards. Example: `--topic /home/bedroom/lamp`

`--private-key [key]`

Ethereum private key to use on the Streamr Network. If you don't have one, you can export a key from a wallet like [Metamask](https://metamask.io/) or generate a private key [here](https://vanity-eth.tk/).

## Additional options

`--verbose`

Give this option to print all the data to the console.

`--public`

Give this option to make all created streams publicly readable. By default, created streams are

private to you.

`--stream-name-template [template]`

Default: `$topic`

Give this option to set how the stream name is constructed from the MQTT topic. 

The string `$topic` in the template is replaced by the actual topic. 

Example: `My MQTT topic: $topic`.

Note that you can direct all data go to a single stream by just defining its name **without** the

placeholder `$topic` in it.

`--stream-id [id]`

If this option is given, all data will be published to a single pre-existing stream with this id. Topic auto-creation will be disabled.

`--topic-levels [num]`

Default: (unlimited)

Number of topic levels to include when auto-creating streams, while truncating subsequent 

topic hierarchy levels. For example, data in `/europe/switzerland` and `/europe/finland` 

would both be produced to stream `/europe` if the topic-level is set to 1.

`--transform [jsonata-syntax]`

Give this option to transform JSON messages before producing them to Streamr. This option follows the 

[JSONata syntax](https://docs.jsonata.org). By default no transform is applied.

`--log-interval [num]`

Default: 60

Stats logging interval in seconds.

`--reconnect-on-data-timeout [num]`

Default: 900

If no data is received for this period of time, try to reconnect to the MQTT broker. The default is 15 minutes. 

Set to 0 to disable.

`--dry-run`

If this option is given, the script doesn't really create streams or produce data to Streamr.

It just reads from the MQTT broker and logs the data to console.

## License

AGPLv3, see [LICENSE](LICENSE).

## TODO

- Utility for the other direction (Streamr to MQTT)