{"id":21371507,"url":"https://github.com/chirpstack/node-red-contrib-chirpstack","last_synced_at":"2026-01-03T21:03:00.178Z","repository":{"id":38364108,"uuid":"397151721","full_name":"chirpstack/node-red-contrib-chirpstack","owner":"chirpstack","description":"ChirpStack Node-RED nodes","archived":false,"fork":false,"pushed_at":"2023-01-24T15:15:38.000Z","size":166,"stargazers_count":14,"open_issues_count":3,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-22T20:51:51.092Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.chirpstack.io/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chirpstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"chirpstack"}},"created_at":"2021-08-17T07:26:25.000Z","updated_at":"2024-12-12T18:35:17.000Z","dependencies_parsed_at":"2023-01-29T02:30:25.931Z","dependency_job_id":null,"html_url":"https://github.com/chirpstack/node-red-contrib-chirpstack","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fnode-red-contrib-chirpstack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fnode-red-contrib-chirpstack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fnode-red-contrib-chirpstack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chirpstack%2Fnode-red-contrib-chirpstack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chirpstack","download_url":"https://codeload.github.com/chirpstack/node-red-contrib-chirpstack/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243846982,"owners_count":20357297,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T08:13:41.415Z","updated_at":"2026-01-03T21:03:00.122Z","avatar_url":"https://github.com/chirpstack.png","language":"HTML","readme":"# ChirpStack Node-RED nodes\n\nThis package contains [ChirpStack](https://www.chirpstack.io/) nodes for\nusing with [Node-RED](https://nodered.org/).\n\n![example flow](example_flow.png)\n\n## Installation\n\nPlease read the [Adding nodes to the palette](https://nodered.org/docs/user-guide/runtime/adding-nodes)\ndocumentation for information on installing third-party nodes to Node-RED.\n\nExample command:\n\n```bash\nnpm install @chirpstack/node-red-contrib-chirpstack\n```\n\n## Usage example\n\nThis usage example creates an echo flow, which returns the received uplink back\nto the device.\n\n### MQTT in node (Node-RED)\n\nAfter the `@chirpstack/node-red-contrib-chirpstack` package has been installed,\nthe first thing you must do is create a MQTT subscription using the *mqtt in*\nnode.\n\n* Add the *mqtt in* node to your flow.\n* Under properties select *Add new mqtt-broker...* and click the pencil icon.\n* Enter the hostname of the server, when using TLS the port-number is usually `8883`, else `1883`.\n* When using TLS make sure the *Use TLS* option is checked, select *Add new tls-config...* and click the pencil button.\n\t* If the MQTT broker is configured with client-certificate authentication and authorization,\n      retrieve the certificate using the *Generate certificate* within the ChirpStack Application\n      Server web-interface. Then upload the retrieved CA certificate, client-certificate and private\n      key. Uncheck *verify server certificate* as the server-certificate will already be validated\n      using the provided CA certificate. The click *Add*.\n* Click once more *Add*, this takes you back to the initial form.\n* As *Topic* enter `application/+/device/+/event/+` (in case you have modifications to the default\n  ChirpStack configuration, modify this topic if needed).\n* Click *Done*.\n\nAfter deploying the flow containing the *mqtt in* node, you should see a green\nbullet under the node with the status *connected*. If that is not the case,\nvalidate the hostname, port and TLS configuration (if appliable).\n\n### Device event node (ChirpStack)\n\nAfter setting up the *mqtt in* node, add one or multiple *device event* nodes.\nFor each node you can select the *Event Type*. For this usage example select\n*Uplink*. Connect this node with the *mqtt in* node.\n\n### Debug node (Node-RED)\n\nAdd a *debug* node and connect it with the *device event [up]* node to log the\n`msg.payload` for debugging.\n\n### Echo function node (Node-RED)\n\nAdd a *function* node, and add the following code to the *On Message* event:\n\n```js\nreturn {\n    \"payload\": msg.payload.data,\n    \"fPort\": msg.payload.fCnt,\n    \"confirmed\": false,\n    \"devEui\": msg.payload.deviceInfo.devEui\n};\n```\n\nConnect this node with the *device event [up]* node.\n\n### Downlink node (ChirpStack)\n\nAdd a *device downlink* node and enter:\n\n* The hostname:port of the server (e.g. `localhost:8080` or `example.com:443`).\n  this is the same hostname and port which is used to access the ChirpStack\n  Application Server, but **without** the `http://` or `https://`.\n* Select *Use TLS* when the endpoint is secured with a TLS certificate.\n* Generate an API Key in the ChirpStack Application Server and paste the\n  token under *API Token*.\n* For this example set the *Payload Encoding* to *Base64*, as the uplink payload\n  is encoded within the JSON payload as Base64.\n\nConnect this node with the echo function node.\n\n### Debug node (Node-RED)\n\nAdd an other *debug* node and connect it with the downlink node. This will\nprint the downlink frame-counter as debugging information. Make sure the\n*Output* is set to *complete msg object*.\n","funding_links":["https://github.com/sponsors/chirpstack"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchirpstack%2Fnode-red-contrib-chirpstack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchirpstack%2Fnode-red-contrib-chirpstack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchirpstack%2Fnode-red-contrib-chirpstack/lists"}