Skip to content

feat: received packets payload logging #970

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.

Sign up for GitHub

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

Open
Pmmlabs wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: received packets payload logging #970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
116 changes: 78 additions & 38 deletions packages/core/src/meshDevice.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
import { create, fromBinary, toBinary } from "@bufbuild/protobuf";
import {
create,
type DescMessage,
fromBinary,
type MessageShape,
toBinary,
} from "@bufbuild/protobuf";
import * as Protobuf from "@meshtastic/protobufs";
import { Logger } from "tslog";

Expand Down Expand Up @@ -931,32 +937,27 @@ export class MeshDevice {
from: meshPacket.from,
to: meshPacket.to,
channel: meshPacket.channel,
hops: Math.min(meshPacket.hopStart - meshPacket.hopLimit, 0),
hops: Math.max(meshPacket.hopStart - meshPacket.hopLimit, 0),
rxRssi: meshPacket.rxRssi,
rxSnr: meshPacket.rxSnr,
viaMqtt: meshPacket.viaMqtt,
};

this.log.trace(
Emitter[Emitter.HandleMeshPacket],
`📦 Received ${Protobuf.Portnums.PortNum[dataPacket.portnum]} packet`,
);

switch (dataPacket.portnum) {
case Protobuf.Portnums.PortNum.TEXT_MESSAGE_APP: {
this.events.onMessagePacket.dispatch({
...packetMetadata,
data: new TextDecoder().decode(dataPacket.payload),
data: new TextDecoder().decode(this.getPayload(dataPacket)),
});
break;
}

case Protobuf.Portnums.PortNum.REMOTE_HARDWARE_APP: {
this.events.onRemoteHardwarePacket.dispatch({
...packetMetadata,
data: fromBinary(
data: this.getPayloadFromProto(
Protobuf.RemoteHardware.HardwareMessageSchema,
dataPacket.payload,
dataPacket,
),
});
break;
Expand All @@ -965,23 +966,26 @@ export class MeshDevice {
case Protobuf.Portnums.PortNum.POSITION_APP: {
this.events.onPositionPacket.dispatch({
...packetMetadata,
data: fromBinary(Protobuf.Mesh.PositionSchema, dataPacket.payload),
data: this.getPayloadFromProto(
Protobuf.Mesh.PositionSchema,
dataPacket,
),
});
break;
}

case Protobuf.Portnums.PortNum.NODEINFO_APP: {
this.events.onUserPacket.dispatch({
...packetMetadata,
data: fromBinary(Protobuf.Mesh.UserSchema, dataPacket.payload),
data: this.getPayloadFromProto(Protobuf.Mesh.UserSchema, dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.ROUTING_APP: {
routingPacket = fromBinary(
routingPacket = this.getPayloadFromProto(
Protobuf.Mesh.RoutingSchema,
dataPacket.payload,
dataPacket,
);

this.events.onRoutingPacket.dispatch({
Expand Down Expand Up @@ -1018,9 +1022,9 @@ export class MeshDevice {
}

case Protobuf.Portnums.PortNum.ADMIN_APP: {
adminMessage = fromBinary(
adminMessage = this.getPayloadFromProto(
Protobuf.Admin.AdminMessageSchema,
dataPacket.payload,
dataPacket,
);
switch (adminMessage.payloadVariant.case) {
case "getChannelResponse": {
Expand Down Expand Up @@ -1088,49 +1092,52 @@ export class MeshDevice {
case Protobuf.Portnums.PortNum.WAYPOINT_APP: {
this.events.onWaypointPacket.dispatch({
...packetMetadata,
data: fromBinary(Protobuf.Mesh.WaypointSchema, dataPacket.payload),
data: this.getPayloadFromProto(
Protobuf.Mesh.WaypointSchema,
dataPacket,
),
});
break;
}

case Protobuf.Portnums.PortNum.AUDIO_APP: {
this.events.onAudioPacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.DETECTION_SENSOR_APP: {
this.events.onDetectionSensorPacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.REPLY_APP: {
this.events.onPingPacket.dispatch({
...packetMetadata,
data: dataPacket.payload, //TODO: decode
data: this.getPayload(dataPacket), //TODO: decode
});
break;
}

case Protobuf.Portnums.PortNum.IP_TUNNEL_APP: {
this.events.onIpTunnelPacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.PAXCOUNTER_APP: {
this.events.onPaxcounterPacket.dispatch({
...packetMetadata,
data: fromBinary(
data: this.getPayloadFromProto(
Protobuf.PaxCount.PaxcountSchema,
dataPacket.payload,
dataPacket,
),
});
break;
Expand All @@ -1139,33 +1146,33 @@ export class MeshDevice {
case Protobuf.Portnums.PortNum.SERIAL_APP: {
this.events.onSerialPacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.STORE_FORWARD_APP: {
this.events.onStoreForwardPacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.RANGE_TEST_APP: {
this.events.onRangeTestPacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.TELEMETRY_APP: {
this.events.onTelemetryPacket.dispatch({
...packetMetadata,
data: fromBinary(
data: this.getPayloadFromProto(
Protobuf.Telemetry.TelemetrySchema,
dataPacket.payload,
dataPacket,
),
});
break;
Expand All @@ -1174,25 +1181,25 @@ export class MeshDevice {
case Protobuf.Portnums.PortNum.ZPS_APP: {
this.events.onZpsPacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.SIMULATOR_APP: {
this.events.onSimulatorPacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.TRACEROUTE_APP: {
this.events.onTraceRoutePacket.dispatch({
...packetMetadata,
data: fromBinary(
data: this.getPayloadFromProto(
Protobuf.Mesh.RouteDiscoverySchema,
dataPacket.payload,
dataPacket,
),
});
break;
Expand All @@ -1201,9 +1208,9 @@ export class MeshDevice {
case Protobuf.Portnums.PortNum.NEIGHBORINFO_APP: {
this.events.onNeighborInfoPacket.dispatch({
...packetMetadata,
data: fromBinary(
data: this.getPayloadFromProto(
Protobuf.Mesh.NeighborInfoSchema,
dataPacket.payload,
dataPacket,
),
});
break;
Expand All @@ -1212,31 +1219,31 @@ export class MeshDevice {
case Protobuf.Portnums.PortNum.ATAK_PLUGIN: {
this.events.onAtakPluginPacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.MAP_REPORT_APP: {
this.events.onMapReportPacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.PRIVATE_APP: {
this.events.onPrivatePacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}

case Protobuf.Portnums.PortNum.ATAK_FORWARDER: {
this.events.onAtakForwarderPacket.dispatch({
...packetMetadata,
data: dataPacket.payload,
data: this.getPayload(dataPacket),
});
break;
}
Expand All @@ -1245,4 +1252,37 @@ export class MeshDevice {
throw new Error(`Unhandled case ${dataPacket.portnum}`);
}
}

private logPacket(portnum: Protobuf.Portnums.PortNum, str: string) {
const isDev = typeof import.meta !== "undefined" && import.meta.env?.DEV;
if (!isDev) {
str = "";
}
this.log.trace(
Emitter[Emitter.HandleMeshPacket],
`📦 Received ${Protobuf.Portnums.PortNum[portnum]} packet with payload:`,
str,
);
}

private getPayload(datapacket: Protobuf.Mesh.Data): Uint8Array {
const hexString = Array.from(datapacket.payload)
.map((byte) => byte.toString(16).padStart(2, "0"))
.join("");
this.logPacket(datapacket.portnum, "0x" + hexString);

return datapacket.payload;
}

private getPayloadFromProto<Desc extends DescMessage>(
schema: Desc,
datapacket: Protobuf.Mesh.Data,
): MessageShape<Desc> {
const message: MessageShape<Desc> = fromBinary(schema, datapacket.payload);
// @ts-expect-error
delete message.$typeName;
this.logPacket(datapacket.portnum, JSON.stringify(message));

return message;
}
}
14 changes: 13 additions & 1 deletion packages/core/src/utils/transform/decodePacket.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,11 @@ export const decodePacket = (device: MeshDevice) =>
}

case "queueStatus": {
// @ts-expect-error
delete decodedMessage.payloadVariant.value.$typeName;
device.log.trace(
Types.Emitter[Types.Emitter.HandleFromRadio],
`🚧 Received Queue Status: ${decodedMessage.payloadVariant.value}`,
`🚧 Received Queue Status: ${JSON.stringify(decodedMessage.payloadVariant.value)}`,
);

device.events.onQueueStatus.dispatch(
Expand Down Expand Up @@ -270,6 +272,16 @@ export const decodePacket = (device: MeshDevice) =>
break;
}

case "deviceuiConfig": {
// @ts-expect-error
delete decodedMessage.payloadVariant.value.$typeName;
device.log.trace(
Types.Emitter[Types.Emitter.HandleFromRadio],
`🔧 Received deviceuiConfig: ${JSON.stringify(decodedMessage.payloadVariant.value)}`,
);
break;
}

default: {
device.log.warn(
Types.Emitter[Types.Emitter.HandleFromRadio],
Expand Down
15 changes: 12 additions & 3 deletions packages/core/src/utils/transform/fromDevice.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,8 @@ export const fromDeviceStream: () => TransformStream<Uint8Array, DeviceOutput> =
packet[malformedDetectorIndex + 1] === 0xc3
) {
console.warn(
`⚠️ Malformed packet found, discarding: ${byteBuffer
.subarray(0, malformedDetectorIndex - 1)
.toString()}`,
`⚠️ Malformed packet found, discarding:`,
toHexString(byteBuffer, malformedDetectorIndex),
);

byteBuffer = byteBuffer.subarray(malformedDetectorIndex);
Expand All @@ -67,3 +66,13 @@ export const fromDeviceStream: () => TransformStream<Uint8Array, DeviceOutput> =
},
});
};

function toHexString(byteBuffer: Uint8Array<ArrayBuffer>, index: number) {
try {
return Array.from(byteBuffer.subarray(0, index - 1))
.map((byte) => byte.toString(16).padStart(2, "0"))
.join("");
} catch (_e) {
return byteBuffer.subarray(0, index - 1).toString();
}
}
3 changes: 2 additions & 1 deletion packages/web/src/components/PageComponents/Messages/MessageItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,8 @@ export const MessageItem = ({ message }: MessageItemProps) => {
<div className="text-xs text-slate-500 dark:text-slate-200 whitespace-pre-wrap break-words">
SNR: {message.rxSnr}, RSSI: {message.rxRssi}
</div>
))}
)) ||
""}
</div>
</div>
{/* Actions Menu Placeholder */}
Expand Down