Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add RA02G Decoder for Netvox Sensor over LoRaWAN #93

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions decoders/connector/netvox/ra02g/connector.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"$schema": "../../../../schema/connector.json",
"name": "netvox RA02G",
"images": {
"logo": "./assets/logo_RA02G.png"
},
"versions": {
"v1.0.0": {
"src": "./v1.0.0/payload.js",
"manifest": "./v1.0.0/payload-config.jsonc"
}
}
}

1 change: 1 addition & 0 deletions decoders/connector/netvox/ra02g/description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Wireless Cigarette Smoke, Vaping, and Bullying Alarm Sensor over LoRaWAN™
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the #

13 changes: 13 additions & 0 deletions decoders/connector/netvox/ra02g/v1.0.0/payload-config.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"$schema": "../../../../../schema/connector_details.json",
"description": "../description.md",
"install_text": "\nRA02G is a smart indoor sensor designed for high-reliability wireless control and alarm detection. It detects smoke, noise, and tampering, providing versatile alarm functionality over LoRaWAN™.\n\nMore information about this device can be found [here.](http://www.netvox.com.tw/products.asp?pro=RA02G) \n",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove or update the link, It's broken.

"install_end_text": "",
"device_annotation": "Wireless cigarette smoke, vaping, and anti-tampering alarm sensor with customizable audio alerts and power outage detection.",
"device_parameters": [],
"networks": [
"../../../../network/lorawan-citykinect/v1.0.0/payload.js",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a reminder: Make sure you've added all the networks this connector can be used with.

"../../../../network/lorawan-chirpstack/v1.0.0/payload.js"
]
}

113 changes: 113 additions & 0 deletions decoders/connector/netvox/ra02g/v1.0.0/payload.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
/* eslint-disable camelcase */
/* eslint-disable no-restricted-syntax */

/*
** RA02G Custom Payload Decoder for TagoIO
** Parses sensor data such as alarms, battery, and environmental readings.
**
*/

const ignore_vars = [];

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add unit tests in order to make sure the connector is working. Please use the Netvox R312a as an example.

function toTagoFormat(object_item, serie, prefix = '') {
const result = [];
for (const key in object_item) {
if (ignore_vars.includes(key)) continue;

if (typeof object_item[key] === 'object') {
result.push({
variable: object_item[key].variable || `${prefix}${key}`,
value: object_item[key].value,
serie: object_item[key].serie || serie,
metadata: object_item[key].metadata,
unit: object_item[key].unit,
location: object_item[key].location,
});
} else {
result.push({
variable: `${prefix}${key}`,
value: object_item[key],
serie,
});
}
}
return result;
}

// Parsing functions for common sensor data types
const batteryParse = x => ({ value: Number((x.readInt8() / 10).toFixed(1)), unit: 'v' });
const temperatureParse = x => ({ value: Number((x.readInt16BE() / 100).toFixed(2)), unit: '°C' });
const humidityParse = x => ({ value: Number((x.readInt16BE() / 100).toFixed(2)), unit: '%' });
const statusParse = x => ({ value: x.readInt8() === 0 ? 'no alarm' : 'alarm' });
const gasParse = x => ({ value: Number((x.readUInt16BE() / 10).toFixed(2)), unit: 'ppm' });
const noiseParse = x => ({ value: Number((x.readUInt16BE() / 10).toFixed(2)), unit: 'db' });
const currentParse = x => ({ value: x.readInt8(), unit: 'ma' });

// Main function to parse RA02G payloads
function parsePayload(payload_raw) {
payload_raw = Buffer.from(payload_raw, 'hex');

if (payload_raw[2] === 0x00) {
return {
software_version: payload_raw.readInt8(3) * 0.1,
hardware_version: payload_raw.readInt8(4),
data_code: payload_raw.slice(5, 9).toString('hex'),
};
}

const deviceType = payload_raw[1];
const reportType = payload_raw[2];

switch (deviceType) {
case 0xD7: {
// Report type 0x01: Alarms and Battery
if (reportType === 0x01) {
return {
battery: batteryParse(payload_raw.slice(3, 4)),
smokeAlarm: statusParse(payload_raw.slice(4, 5)),
soundAlarm: statusParse(payload_raw.slice(5, 6)),
shockAlarm: statusParse(payload_raw.slice(6, 7)),
powerOffAlarm: statusParse(payload_raw.slice(7, 8)),
reserved: payload_raw.slice(8, 11).toString('hex'), // Reserved bytes
};
}
// Report type 0x02: Environmental Data
else if (reportType === 0x02) {
return {
battery: batteryParse(payload_raw.slice(3, 4)),
temperature: temperatureParse(payload_raw.slice(4, 6)),
humidity: humidityParse(payload_raw.slice(6, 8)),
gasLevel: gasParse(payload_raw.slice(8, 10)),
noiseLevel: noiseParse(payload_raw.slice(10, 12)),
};
}
// Report type 0x03: Advanced Electrical Measurements
else if (reportType === 0x03) {
return {
battery: batteryParse(payload_raw.slice(3, 4)),
current: currentParse(payload_raw.slice(4, 5)),
voltage: { value: payload_raw.slice(5, 7).readInt16BE(), unit: 'V' },
power: { value: payload_raw.slice(7, 9).readInt16BE(), unit: 'W' },
};
}
// Unknown report type
else {
return { payload: payload_raw.join(''), parse_error: 'Report Type not recognized for RA02G.' };
}
}
default:
return { payload: payload_raw.join(''), parse_error: 'Device Type not recognized.' };
}
}

// Filter out unwanted variables from processing
payload = payload.filter(x => !ignore_vars.includes(x.variable));

// Extract and parse payload data if available
const data = payload.find(x => ['payload', 'payload_raw', 'data'].includes(x.variable));
if (data) {
const { value, serie } = data;
if (value) {
payload = payload.concat(toTagoFormat(parsePayload(value), serie));
}
}