wss://device.nerves-hub.org/socket/websocket
. Once connected, you can then join any of the supported channel topics to start sending and receiving messages with NervesHub.[join_ref, ref, topic, event, payload]
. (See the Phoenix.Socket.Message
documetation for more info on what each part of the message means)phx_join
event to the desired topic:device
- The main topic a device should join for receiving updates and other device specific events.console
- topic for the device to send IO requests to and from NervesHub for supporting remote console interaction. For Nerves, this is the topic used from remote IEx sessions.update
update_available
- Boolean stating update availabilitydeployment_id
- ID of the deployment triggering the updatefirmware_url
- URL where the firmware file can be downloaded. Note: this has a default TTL of 10 minutes. Using the URL after that time will fail and a new update request will need to be sent for a new URLfirmware_meta
- Contains a map of the various metadata elements for the firmwareuuid
architecture
platform
product
version
author
description
vcs_identifier
misc
reboot
phx_err
reason
- text of failure reasonphx_close
rebooting
fwup_progress
value
- percentage of update progressstatus_update
status
- One of the supported statuses for a deviceidle
- waiting for an updatefwup_error
- error occurred in the fwup processupdate_failed
update_rescheduled
unknown
- generic status for unhandled states