NervesHubLink (nerves_hub_link v2.7.2)
View SourceThe Device-side client for NervesHub.
The :nerves_hub_link
Erlang application will start by default if installed
as a dependency and use provided configuration to connect to a NervesHub
server.
This module primarily provides utility functions for checking the status of the connection and performing some operations such as reconnecting, sending a file to a connected console and more.
Summary
Functions
Checks if the device is connected to the NervesHub device channel.
Return whether there's currently an active console session
Checks if the device is connected to the NervesHub console channel.
Checks if the device is connected to the NervesHub extensions channel.
Restart the socket and device channel
Send a file to the connected console
Send update progress percentage for display in web
Send an update status to web
Checks if the device has a socket connection with NervesHub
Current status of the update manager
Functions
@spec connected?() :: boolean()
Checks if the device is connected to the NervesHub device channel.
@spec console_active?() :: boolean()
Return whether there's currently an active console session
@spec console_connected?() :: boolean()
Checks if the device is connected to the NervesHub console channel.
@spec extensions_connected?() :: boolean()
Checks if the device is connected to the NervesHub extensions channel.
@spec reconnect() :: :ok
Restart the socket and device channel
@spec send_file(Path.t()) :: :ok | {:error, :too_large | File.posix()}
Send a file to the connected console
@spec send_update_progress(non_neg_integer()) :: :ok
Send update progress percentage for display in web
Send an update status to web
@spec socket_connected?() :: boolean()
Checks if the device has a socket connection with NervesHub
@spec status() :: NervesHubLink.UpdateManager.status()
Current status of the update manager