Skip to content

Commit

Permalink
Add Internal API versions to the README (#224)
Browse files Browse the repository at this point in the history
Clarify what features are enabled in the different API versions.
  • Loading branch information
oestrich authored Aug 6, 2024
1 parent a4de3b6 commit 72745c2
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,3 +312,18 @@ Another possibility is that the device wasn't provisioned with the certificate
that's on NervesHub.

See also [NervesHubWeb: Potential SSL Issues](https://github.com/nerves-hub/nerves_hub_web#potential-ssl-issues)

## Internal API Versions

`NervesHubLink.Configurator` includes two internal versions for NervesHub to determine what features are available on the device socket.

### `device_api_version`

- `1.0.0` - Updating firmware, status updates, reboot device
- `2.0.0` - Identify a device, archives
- `2.1.0` - Run scripts on a device separate from the console, sync firmware keys and archive keys

### `console_version`

- `1.0.0` - Remote IEx console
- `2.0.0` - Send and receive files from a device

0 comments on commit 72745c2

Please sign in to comment.