nerves_runtime

v0.9.0

nerves_runtime v0.9.0 Nerves.Runtime

Nerves.Runtime contains functions useful for almost all Nerves-based devices.

Link to this section Summary

Types

revert_options()

Options for Nerves.Runtime.revert/1

Functions

cmd(cmd, params, out)

Run system command and log output into logger

halt()

Halt the device (meaning hang, not power off, nor reboot)

poweroff()

Power off the device

reboot()

Reboot the device and gracefully shutdown the Erlang VM

revert(opts \\ [])

Revert the device to running the previous firmware

target()

Link to this section Types

Link to this type

revert_options() 
revert_options() :: {:reboot, boolean()}

Options for Nerves.Runtime.revert/1.

Link to this section Functions

Link to this function

cmd(cmd, params, out) 
cmd(binary(), [binary()], :debug | :info | :warn | :error | :return) ::
  {Collectable.t(), exit_status :: non_neg_integer()}

Run system command and log output into logger.

Link to this function

halt() 
halt() :: no_return()

Halt the device (meaning hang, not power off, nor reboot).

Note: this is different than :erlang.halt(), which exits BEAM, and may end up rebooting the device if erlinit.config settings allow reboot on exit.

Link to this function

poweroff() 
poweroff() :: no_return()

Power off the device.

This calls :init.stop/0 internally. If :init.stop/0 takes longer than the erlinit.config's --graceful-powerdown setting (likely 10 seconds) then the system will be hard rebooted.

Link to this function

reboot() 
reboot() :: no_return()

Reboot the device and gracefully shutdown the Erlang VM.

This calls :init.stop/0 internally. If :init.stop/0 takes longer than the erlinit.config's --graceful-powerdown setting (likely 10 seconds) then the system will be hard rebooted.

Link to this function

revert(opts \\ []) 
revert([revert_options()]) :: :ok | {:error, reason :: any()}

Revert the device to running the previous firmware.

This requires a specially constructed fw file.

Link to this function

target()