Skip to content

Commit dec9030

Browse files
authored
Enhance Readme with DeviceHub and ChallengeHub usage
Added detailed instructions for using DeviceHub and ChallengeHub with websocket connections, including token usage and message formats.
1 parent 077c2c7 commit dec9030

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

doc/Readme.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,51 @@ Take care not to share your tokens as they are not encrypted and contain persona
2929
# Using Postman to send payloads to devicehub or challengehub
3030
## Prerequisite: you need to have your tokens on hand, they are relatively short lived so once you have them, get to connecting!
3131

32+
### DeviceHub
33+
34+
1. Open up a new websocket connection and paste the DeviceHub URL
35+
2. In Headers, add "Authorization".
36+
3. In the Authorization field, type in "Bearer" then a space, and paste your DeviceHub token.
37+
<img width="856" height="479" alt="image" src="https://github.com/user-attachments/assets/6ff6540d-066b-4ea2-a640-5bcaada9ea09" />
38+
4. Go to the "Messages" tab and type in. Notice the control character at the end chr(30). It is required.
39+
40+
```
41+
{
42+
"protocol": "json",
43+
"version": 1
44+
}
45+
```
46+
5. You can then invoke "SubscribeToLocation" to get your device informations.
47+
```
48+
{
49+
"arguments": [
50+
69420
51+
],
52+
"invocationId": "0",
53+
"target": "SubscribeToLocation",
54+
"type": 1
55+
}
56+
```
57+
### ChallengeHub
58+
59+
1. Open up a new websocket connection and paste the DeviceHub URL
60+
2. In Headers, add "Authorization".
61+
3. In the Authorization field, type in "Bearer" then a space, and paste your DeviceHub token.
62+
<img width="856" height="479" alt="image" src="https://github.com/user-attachments/assets/6ff6540d-066b-4ea2-a640-5bcaada9ea09" />
63+
4. Go to the "Messages" tab and type in. Notice the control character at the end chr(30). It is required.
64+
65+
```
66+
{
67+
"protocol": "json",
68+
"version": 1
69+
}
70+
```
71+
5. You can send various messages to the ChallengeHub to request different information. Some replies are documented here.
72+
73+
# TODO: ADD INVOKES ARE THEIR REPLIES
74+
75+
76+
77+
78+
3279

0 commit comments

Comments
 (0)