Skip to content
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

Jump to bottom

Add initial doc for imperial #7

Merged
merged 14 commits into from
Nov 10, 2021
Merged

Add initial doc for imperial #7

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
e6dc819
Add initial doc for imperial
jesserockz Jul 1, 2021
73d155d
Add version byte
jesserockz Aug 23, 2021
0f15fa0
Add command 0x02 to request current state from device.
jesserockz Aug 23, 2021
5643c20
Add message about response for requesting current state
jesserockz Aug 23, 2021
4c9f087
Note about packet count
jesserockz Aug 24, 2021
fac4d1e
Change imperial to improv via serial
jesserockz Oct 11, 2021
23a25a1
Add improv serial to menu
jesserockz Oct 11, 2021
b4e5e37
Rename ble doc page and add redirect
jesserockz Oct 12, 2021
231c294
Rename serial page
jesserockz Oct 12, 2021
6215358
Update index and template to include serial
jesserockz Oct 12, 2021
e135ca6
Tidy up ESPHome section
jesserockz Oct 12, 2021
9c32609
Update docs
balloob Nov 5, 2021
3eaaf7c
More tweaks
balloob Nov 6, 2021
cd25c0a
Add RPC command for device information
jesserockz Nov 10, 2021
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
32 changes: 17 additions & 15 deletions src/imperial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
layout: base
title: Documentation
title: Imperial
description:
---

## Imperial Service

... (To be written)
Imperial is Improv via Serial and allows a client to send the Wi-Fi credentials to a device to save via a serial connection.

### Serial packet format

Expand Down Expand Up @@ -65,15 +65,15 @@ Submit Wi-Fi credentials to the Improv Service to attempt to connect to.

Command ID: `0x01`

| Byte | Description |
| ---- | --------------- |
| 01 | command |
| xx | data length |
| yy | ssid length |
| | ssid bytes |
| zz | password length |
| | password bytes |
| CS | checksum |
| Byte | Description |
| ----- | ---------------- |
| 1 | command (`0x01`) |
| 2 | data length |
| 3 | ssid length |
| 4...X | ssid bytes |
| X | password length |
| X...Y | password bytes |
| Y | checksum |

Example: SSID = MyWirelessAP, Password = mysecurepassword

Expand All @@ -89,9 +89,11 @@ Sends a request for the device to send the current state of imperial to the clie

Command ID: `0x02`

| Byte | Description |
| ---- | --------------- |
| 01 | command (0x02) |
| Byte | Description |
| ---- | ---------------- |
| 1 | command (`0x02`) |

This command will trigger two packets, the `Current State` (see above) and the same response you would get if device provisioning was successful (see below).
jesserockz marked this conversation as resolved.
Show resolved Hide resolved


### RPC Result (_Device to client_)
Expand All @@ -102,7 +104,7 @@ This message type contains the response to a RPC command. Results are returned a

| Byte | Description |
| --------- | ----------------------------------------------------- |
| 1 | Command (see below) |
| 1 | Command being responded to (see above) |
| 2 | Data length |
| 3 | Length of string 1 |
| 4...X | String 1 |
Expand Down