NervesKey.OTP (nerves_key v1.1.0) View Source

This module handles OTP data stored in the NervesKey.

Link to this section Summary

Types

raw()

t()

Functions

Convert a raw configuration to a nice map.

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

new(board_name, manufacturer_sn, user \\ nil)

Create a NervesKey OTP data struct

read(transport)

Read NervesKey information from the OTP data.

Convert a nice config map back to a raw configuration

write(transport, data)

Write NervesKey information to the OTP zone.

Link to this section Types

raw()

Specs

raw() :: <<_::512>>

t()

Specs

t() :: %NervesKey.OTP{
  board_name: binary(),
  flags: 0..65535,
  manufacturer_sn: binary(),
  user: <<_::256>>
}

Link to this section Functions

from_raw(arg1)

Specs

from_raw(raw()) :: {:ok, t()} | {:error, atom()}

Convert a raw configuration to a nice map.

from_raw!(raw)

Specs

from_raw!(raw()) :: t()

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

new(board_name, manufacturer_sn, user \\ nil)

Specs

new(String.t(), String.t(), binary() | nil) :: t()

Create a NervesKey OTP data struct

read(transport)

Specs

read(ATECC508A.Transport.t()) :: {:ok, t()} | {:error, atom()}

Read NervesKey information from the OTP data.

to_raw(info)

Specs

to_raw(t()) :: raw()

Convert a nice config map back to a raw configuration

write(transport, data)

Specs

write(ATECC508A.Transport.t(), raw()) :: :ok | {:error, atom()}

Write NervesKey information to the OTP zone.