nerves_key v0.1.1 NervesKey.OTP View Source

This module handles OTP data stored in the Nerves Key.

Link to this section Summary

Functions

Convert a raw configuration to a nice map. Raise if there is an error

Convert a raw configuration to a nice map

Read Nerves Key information from the OTP data

Convert a nice config map back to a raw configuration

Write Nerves Key information to the OTP zone

Link to this section Types

Link to this type t() View Source
t() :: %NervesKey.OTP{
  board_name: binary(),
  flags: non_neg_integer(),
  manufacturer_sn: binary(),
  user: <<_::256>>
}

Link to this section Functions

Link to this function from_raw!(raw) View Source
from_raw!(<<_::512>>) :: t() | no_return()

Convert a raw configuration to a nice map. Raise if there is an error.

Link to this function from_raw(arg1) View Source
from_raw(<<_::512>>) :: {:ok, t()} | {:error, atom()}

Convert a raw configuration to a nice map.

Link to this function new(board_name, manufacturer_sn, user \\ <<0::size(256)>>) View Source
new(String.t(), String.t(), binary()) :: t()

Create a Nerves Key OTP data struct

Link to this function read(transport) View Source
read(ATECC508A.Transport.t()) :: {:ok, t()} | {:error, atom()}

Read Nerves Key information from the OTP data.

Link to this function to_raw(info) View Source
to_raw(t()) :: <<_::512>>

Convert a nice config map back to a raw configuration

Link to this function write(transport, data) View Source
write(ATECC508A.Transport.t(), binary()) :: :ok | {:error, atom()}

Write Nerves Key information to the OTP zone.