blue_heron v0.4.1

BlueHeron.ErrorCode (blue_heron v0.4.1) View Source

Defines all error codes and functions to map between error code and name.

When a command fails, or an LMP, LL, or AMP message needs to indicate a failure, error codes are used to indicate the reason for the error. Error codes have a size of one octet.

Reference: Version 5.0, Vol 2, Part D, 1

Link to this section Summary

Functions

to_atom(code)
to_code(status)
to_code!(status)
to_string(atom)

Link to this section Functions

Link to this function

to_atom(code)

View Source

Specs

to_atom(non_neg_integer()) :: atom()
Link to this function

to_code(status)

View Source

Specs

to_code(non_neg_integer() | atom()) :: non_neg_integer() | :error
Link to this function

to_code!(status)

View Source

Specs

to_code!(non_neg_integer() | atom()) :: non_neg_integer()
Link to this function

to_string(atom)

View Source

Specs

to_string(atom()) :: String.t() | :error