mirror of
https://github.com/dpup/meshstream.git
synced 2026-07-04 00:42:13 +02:00
Daniel Pupius
c6de28aacb
- Added new web/ directory for frontend development - Created fixtures/ subdirectory with JSON test data - Added samples for all major packet types (text, position, nodeinfo, etc.) - Added README files with documentation - Added placeholder package.json 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
# Fixture Data for Testing
|
|
|
|
This directory contains sample JSON data files that represent different types of Meshtastic packets. These fixtures can be used for testing the web application without requiring a live MQTT connection.
|
|
|
|
## Available Fixtures
|
|
|
|
- **text_message.json**: A simple text message sent over the Meshtastic network
|
|
- **position.json**: A position update with GPS coordinates
|
|
- **nodeinfo.json**: Information about a node in the Meshtastic network
|
|
- **telemetry.json**: Device and environmental telemetry data
|
|
- **map_report.json**: A report containing multiple nodes and their positions
|
|
- **waypoint.json**: A waypoint/point of interest
|
|
- **decode_error.json**: An example of a packet that couldn't be properly decoded
|
|
|
|
## Using the Fixtures
|
|
|
|
These JSON files match the format that would be received from the server's SSE endpoint, which delivers data in the format:
|
|
|
|
```
|
|
event: message
|
|
data: {... JSON payload ...}
|
|
```
|
|
|
|
The fixtures can be used in unit tests, for mocking the API during development, or as examples for documentation.
|
|
|
|
## Data Structure
|
|
|
|
Each fixture follows this general pattern:
|
|
|
|
```json
|
|
{
|
|
"info": {
|
|
"fullTopic": "msh/REGION_PATH/2/e/CHANNELNAME/USERID",
|
|
"regionPath": "...",
|
|
"version": "2",
|
|
"format": "e",
|
|
"channel": "...",
|
|
"userId": "..."
|
|
},
|
|
"data": {
|
|
"channelId": "...",
|
|
"gatewayId": "...",
|
|
"id": 1234567890,
|
|
"from": 1234567890,
|
|
"to": 4294967295,
|
|
"hopLimit": 3,
|
|
"hopStart": 3,
|
|
"priority": "...",
|
|
"portNum": "...",
|
|
"...": "...", // Payload-specific fields
|
|
"requestId": 0,
|
|
"replyId": 0,
|
|
"wantResponse": false
|
|
}
|
|
}
|
|
```
|
|
|
|
The payload fields in `data` depend on the message type, as indicated by the `portNum` field. |