Files
meshtastic-cli-iobroker-mqtt/meshcli_iobroker.js
T
2026-01-28 20:06:49 +01:00

349 lines
12 KiB
JavaScript

// this script/idea is based on https://forum.iobroker.net/topic/73326/meshtastic/2
// Meshtastic ioBroker Integration Kit (Full Script)
// Configuration of IP adress of meshtastic node that is connected via TCP
var deviceIp = '<IP-of-your-meshtastic-node>';
// Configuration of MQTT instance that is used (in my case 3rd instance)
var mqttPath = 'mqtt.3.msh.*.json.*';
var chats = [
{ name: 'Default', id: 0 },
{ name: 'Puig', id: 1 },
{ name: 'Baleares', id: 2 }
];
// ======================================================
// 1. MQTT TRIGGER (Realtime Chat + Name Resolution)
// ======================================================
on({id: /^mqtt\.3\.msh\..*\.json\..*$/, change: "any"}, function (obj) {
try {
if (!obj.state.val) return;
const msg = JSON.parse(obj.state.val);
if (msg.payload && msg.payload.text) {
const text = msg.payload.text;
const channelIdx = msg.channel || 0;
let senderHex = parseInt(msg.from).toString(16).toLowerCase();
const nodeBasePath = '0_userdata.0.Meshtastic.Nodes.' + senderHex;
const nodeMsgPath = nodeBasePath + '.info.lastMessage';
// --- Name Resolution ---
let displayName = senderHex;
let aliasPath = nodeBasePath + '.info.alias';
let userPath = nodeBasePath + '.info.user';
if (existsState(aliasPath)) {
let aliasVal = getState(aliasPath).val;
if (aliasVal && aliasVal !== 'N/A') {
displayName = aliasVal;
} else if (existsState(userPath)) {
displayName = getState(userPath).val;
}
}
// Save in Node Info
if (getObject(nodeBasePath)) {
if (!existsState(nodeMsgPath)) {
setObject(nodeMsgPath, {
type: 'state',
common: { name: 'Letzte Nachricht', type: 'string', role: 'text', read: true, write: false },
native: {}
});
}
setState(nodeMsgPath, text, true);
}
// Save in Chat Channel
const chatMsgPath = '0_userdata.0.Meshtastic.Chats.' + channelIdx + '.lastMessage';
if (getObject('0_userdata.0.Meshtastic.Chats.' + channelIdx)) {
setState(chatMsgPath, `${displayName}: ${text}`, true);
}
log(`Meshtastic Chat [${channelIdx}]: ${displayName} sagt "${text}"`);
}
} catch (e) {
log("Fehler im MQTT Trigger: " + e, "error");
}
});
// ======================================================
// 2. CLI Node Polling + Parsing
// ======================================================
function updateNodes() {
exec('/home/iobroker/.local/bin/meshtastic --host ' + deviceIp + ' --nodes', function (error, result, stderr) {
if (result && result.includes('Connected to radio')) {
var nodes = parseData(result);
handleNodes(nodes);
}
});
}
function handleNodes(nodes) {
nodes.forEach(node => {
node.ID = node.ID.replace("!", "");
if (nodeIsKnown(node.ID)) {
updateNode(node);
} else {
createNode(node);
setTimeout(() => updateNode(node), 4000);
}
});
}
function nodeIsKnown(id) {
return !!getObject('0_userdata.0.Meshtastic.Nodes.' + id);
}
function parseData(data) {
const lines = data.trim().split('\n');
const headerIndex = lines.findIndex(l => l.includes('│') && l.includes('ID'));
if (headerIndex === -1) return [];
const keys = lines[headerIndex].split('│').map(k => k.trim()).filter((k, i, arr) => i > 0 && i < arr.length - 1);
return lines.filter(l => l.includes('│') && !l.includes('═') && !l.includes('─') && !l.includes(' User '))
.map(line => {
let values = line.split('│').map(v => v.trim()).slice(1, -1);
if (values.length < keys.length) return null;
let obj = {};
keys.forEach((key, index) => { obj[key] = values[index] || "N/A"; });
return obj;
}).filter(obj => obj !== null);
}
// ======================================================
// 3. Node Creation + Info States + Command States
// ======================================================
function createNode(data) {
log("creating new node " + data.User, "info");
setObject('0_userdata.0.Meshtastic.Nodes.' + data.ID, {
type: 'channel',
common: { name: data.User },
native: {}
});
createNodeStates(data.ID);
}
function createNodeStates(id) {
// Info Channel
setObject('0_userdata.0.Meshtastic.Nodes.' + id + '.info', {
type: 'channel',
common: { name: 'Info' },
native: {}
});
// Info States
var nodeInfoStates = [
{id: 'id', name: 'NodeID', type: 'string'},
{id: 'user', name: 'User', type: 'string'},
{id: 'alias', name: 'Alias', type: 'string'},
{id: 'location', name: 'Location', type: 'string', role: 'value.gps'}, // for JARVIS map
{id: 'latitude', name: 'Latitude', type: 'number', role: 'value.gps.latitude'},
{id: 'longitude', name: 'Longitude', type: 'number', role: 'value.gps.longitude'},
{id: 'altitude', name: 'Altitude', type: 'number', unit: 'm'},
{id: 'chanUtil', name: 'Channel util.', type: 'number', unit: '%'},
{id: 'txAir', name: 'Tx air util.', type: 'number', unit: '%'},
{id: 'snr', name: 'SNR', type: 'number', unit: 'dB'},
{id: 'channel', name: 'Channel', type: 'string'},
{id: 'lastHeard', name: 'Last heard', type: 'string'},
{id: 'battery', name: 'Battery', type: 'number', unit: '%'},
{id: 'lastMessage', name: 'Letzte Nachricht', type: 'string'}
];
nodeInfoStates.forEach(state => {
setObject('0_userdata.0.Meshtastic.Nodes.' + id + '.info.' + state.id, {
type: 'state',
common: {
name: state.name,
type: state.type === 'string' ? 'string' :
state.type === 'number' ? 'number' :
state.type === 'boolean' ? 'boolean' : 'string', // cast TS
role: state.role || 'value',
unit: state.unit || null,
read: true,
write: false,
def: state.type === 'number' ? 0 : ''
},
native: {}
});
});
// Command Channel
setObject('0_userdata.0.Meshtastic.Nodes.' + id + '.command', {
type: 'channel',
common: { name: 'Command' },
native: {}
});
// Command States
var nodeCommandStates = [
{id: 'sendMessage', name: 'Direktnachricht senden', type: 'string', role: 'value'},
{id: 'sendPing', name: 'Ping senden', type: 'boolean', role: 'button'},
{id: 'sendTraceRoute', name: 'Traceroute starten', type: 'boolean', role: 'button'},
{id: 'getLocation', name: 'Standort anfordern', type: 'boolean', role: 'button'},
{id: 'getTelemetry', name: 'Telemetrie anfordern', type: 'boolean', role: 'button'}
];
nodeCommandStates.forEach(state => {
setObject('0_userdata.0.Meshtastic.Nodes.' + id + '.command.' + state.id, {
type: 'state',
common: {
name: state.name,
type: state.type === 'string' ? 'string' :
state.type === 'number' ? 'number' :
state.type === 'boolean' ? 'boolean' : 'string',
role: state.role,
read: true,
write: true,
def: state.type === 'number' ? 0 : ''
},
native: {}
});
});
}
// ======================================================
// 4. Update Node Values (Location + Lat/Lon separated)
// ======================================================
function updateNode(data) {
function parseNum(val) {
if (!val || val === "N/A") return 0;
return parseFloat(val.replace(/[^\d.-]/g, "")) || 0;
}
const path = '0_userdata.0.Meshtastic.Nodes.' + data.ID + '.info.';
setState(path + "id", data.N, true);
setState(path + "user", data.User, true);
setState(path + "alias", data.AKA, true);
let lat = parseNum(data.Latitude);
let lon = parseNum(data.Longitude);
setState(path + "latitude", lat, true);
setState(path + "longitude", lon, true);
setState(path + "location", lat + ", " + lon, true);
setState(path + "altitude", parseNum(data.Altitude), true);
setState(path + "chanUtil", parseNum(data["Channel util."]), true);
setState(path + "txAir", parseNum(data["Tx air util."]), true);
setState(path + "snr", parseNum(data.SNR), true);
setState(path + "channel", data.Channel, true);
setState(path + "lastHeard", data.LastHeard, true);
setState(path + "battery", parseNum(data.Battery), true);
}
// ======================================================
// 5. Chats + SendMessage Endpoint
// ======================================================
function createChannels() {
setObject('0_userdata.0.Meshtastic', { type: 'channel', common: { name: 'Meshtastic Server' }, native: {} });
setObject('0_userdata.0.Meshtastic.Nodes', { type: 'channel', common: { name: 'Nodes' }, native: {} });
setObject('0_userdata.0.Meshtastic.Chats', { type: 'channel', common: { name: 'Chats' }, native: {} });
}
function createChats() {
chats.forEach(chatObj => {
// create channels
setObject('0_userdata.0.Meshtastic.Chats.' + chatObj.id, {
type: 'channel',
common: {
name: chatObj.name
},
native: {}
});
// last message (read-only)
setObject('0_userdata.0.Meshtastic.Chats.' + chatObj.id + '.lastMessage', {
type: 'state',
common: {
name: 'Letzte Nachricht',
type: 'string',
role: 'text',
read: true,
write: false
},
native: {}
});
// send message (allow writing)
setObject('0_userdata.0.Meshtastic.Chats.' + chatObj.id + '.sendMessage', {
type: 'state',
common: {
name: 'Nachricht senden',
type: 'string',
role: 'text',
read: true,
write: true
},
native: {}
});
});
}
// ======================================================
// 6. Command Listener + CLI Actions
// ======================================================
function registerEndpointListeners() {
$('state[id=0_userdata.0.Meshtastic.Nodes.*.command.*]').each(function (id) {
on({id: id, change: "any"}, function (obj) {
let parts = obj.id.split(".");
let nodeId = parts[4];
let cmd = parts[6];
if (cmd === "getTelemetry" || cmd === "getLocation") requestTelemetry(nodeId);
if (cmd === "sendPing") sendPing(nodeId);
if (cmd === "sendTraceRoute") startTraceroute(nodeId);
if (cmd === "sendMessage") {
let msg = getState(obj.id).val;
sendDirectMessage(nodeId, msg);
}
});
});
$('state[id=0_userdata.0.Meshtastic.Chats.*.sendMessage]').each(function (id) {
on({id: id, change: "any"}, function (obj) {
let parts = obj.id.split(".");
let chatId = parts[4];
let msg = getState(obj.id).val;
sendChatMessage(chatId, msg);
});
});
}
// --- CLI Actions ---
function requestTelemetry(target) {
exec('/home/iobroker/.local/bin/meshtastic --host '+deviceIp+' --request-telemetry --dest "!'+target+'"');
}
function startTraceroute(target) {
exec('/home/iobroker/.local/bin/meshtastic --host '+deviceIp+' --traceroute --dest "!'+target+'"');
}
function sendPing(target) {
exec('/home/iobroker/.local/bin/meshtastic --host '+deviceIp+' --sendping --dest "!'+target+'"');
}
function sendDirectMessage(target, message) {
exec('/home/iobroker/.local/bin/meshtastic --host '+deviceIp+' --dest "!'+target+'" --sendtext "'+message+'"');
}
function sendChatMessage(chatId, message) {
exec('/home/iobroker/.local/bin/meshtastic --host '+deviceIp+' --ch-index '+chatId+' --sendtext "'+message+'"');
}
// ======================================================
// INIT
// ======================================================
createChannels();
createChats();
registerEndpointListeners();
updateNodes();
setInterval(updateNodes, 300000);