https://github.com/seeed-solution/sensecap-decoder
https://github.com/seeed-solution/sensecap-decoder
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/seeed-solution/sensecap-decoder
- Owner: Seeed-Solution
- Created: 2023-04-25T05:39:46.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T01:04:22.000Z (about 1 year ago)
- Last Synced: 2025-04-08T02:22:02.204Z (about 1 year ago)
- Language: JavaScript
- Size: 135 KB
- Stars: 23
- Watchers: 3
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SenseCAP-Decoder
TTN payload decoding script for SenseCAP LoRaWAN messages
This script is used for decoding the LoRaWAN messages sent from the SenseCAP nodes. After decoding, users' applications will get more friendly and readable messages from TTN data API.
## How to Use
#### 1. Prerequisites
We assume that you already setup your gateway and SenseCAP nodes correctly, and the SenseCAP nodes can send messages to your TTN application. You can already observe the data transmisstion through TTN console.
#### 2. Configure the Payload Decoder
- Please navigate to the `Payload Formats` tab of your application to which your SenseCAP nodes send data.
- Select `Custom` for `Payload Format`
- Copy and paste the whole contents of `decoder.js` to the `decoder` textarea.
> If you are using the latest version of TTN v3, you may encounter an error that exceeds the character limit. In this case, you will need to use `decoder_new-v3-uglifyjs.js` instead.
- Click `save payload functions`
#### 3. Check the Decoded Messages
You may test the decoding script with sample payload first. To do this, just copy `01 01 10 98 53 00 00 01 02 10 A8 7A 00 00 AF 51` into the `Payload` text input, and click `Test` button. If succeeded, you will see a successfully parsed JSON structure below.
Then let's check out the magic of the script. We navigate to the `Data` tab, and you can expand any uploaded message to check the `Fields` in the payload. These fields are just populated by the script.
If you're subscribing the messages with TTN's MQTT Data API, you will also get parsed JSON payload fields.
```
Client mosq-TCSlhYcKaRCn3cIePE received PUBLISH (d0, q0, r0, m0, 'lorawan868/devices/2cf7f12010700041/up', ... (719 bytes))
lorawan868/devices/2cf7f12010700041/up {"app_id":"lorawan868","dev_id":"2cf7f12010700041","hardware_serial":"2CF7F12010700041","port":2,"counter":1119,"confirmed":true,"payload_raw":"AQEQYG0AAAECEOj9AACWSA==","payload_fields":{"err":0,"messages":[{"measurementId":4097,"measurementValue":28,"type":"report_telemetry"},{"measurementId":4098,"measurementValue":65,"type":"report_telemetry"}],"payload":"010110606D0000010210E8FD00009648","valid":true},"metadata":{"time":"2020-03-13T09:09:45.834032725Z","frequency":867.3,"modulation":"LORA","data_rate":"SF7BW125","airtime":66816000,"coding_rate":"4/5","gateways":[{"gtw_id":"eui-2cf7f11014300001","timestamp":1779605971,"time":"2020-03-13T09:09:45.672666033Z","channel":4,"rssi":-66,"snr":8.8,"rf_chain":0}]}}
```
## Reference
How many message types and what's the structure of each message type?
We will document the latest message types in the comment header of the script. Please check out [here](https://github.com/Seeed-Solution/TTN-Payload-Decoder/blob/master/decoder.js#L1).