smartpager/dispatcher
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

extended the readme

Browse source
This commit is contained in:
cheetah 2021-03-26 20:02:29 +00:00
parent 733819ad4e
commit d7dec260cd
1 changed files with 26 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -11,4 +11,29 @@ Features in W.I.P:
- Still missing a RX path and processing (Message gets passed along every Device Class, which then tries to parse it, if successfull it breaks the processing loop and the Device Class handles decoding+status handling for delivery) - Still missing a RX path and processing (Message gets passed along every Device Class, which then tries to parse it, if successfull it breaks the processing loop and the Device Class handles decoding+status handling for delivery)
Planned: Planned:
- WebSocket Live Routing Status - WebSocket Live Routing Status
API Server running on Port `3000`
API Calls:
| GET `/api/message/ack/recv/<id>` - marks a Message as Delivered
| GET `/api/message/status/<id>` - fetches the current Message Data(DeliveryLog, Payload, etc.)
| POST `/api/message/advanced` - Creates a new Message and starts delivering it. HTTP Body is a JSON Object. for example:
```json
{
"type": "duplex",
"routing": {
"device": "birdyslim",
"connectors": [
[ "dummy", "fail" ],
[ "pocsag", "133701D" ],
[ "dummy", "works" ]
]
},
"payload": "Testbericht"
}```