grizzly v0.8.7 Grizzly.CommandClass.Association.Remove View Source

Command for working with Association command class REMOVE command

Command Options:

  • :group - The association group
  • :nodes - List of node ids to remove from the group
  • :seq_number - The sequence number used in the Z/IP packet
  • :retries - The number of attempts to send the command (default 2)

Link to this section Summary

Link to this section Types

Link to this type

associated_nodes() View Source
associated_nodes() :: [Grizzly.Node.node_id()]

Link to this type

opts() View Source
opts() ::
  {:group, byte()}
  | {:nodes, associated_nodes()}
  | {:seq_number, Grizzly.seq_number()}
  | {:retries, non_neg_integer()}

Link to this type

t() View Source
t() :: %Grizzly.CommandClass.Association.Remove{
  exec_state: term(),
  group: byte(),
  nodes: associated_nodes(),
  retries: non_neg_integer(),
  seq_number: Grizzly.seq_number()
}

Link to this section Functions

Link to this function

encode(command) View Source
encode(t()) :: {:ok, binary()} | {:error, Grizzly.Command.EncodeError.t()}

Callback implementation for Grizzly.Command.encode/1.

Link to this function

handle_response(command, packet) View Source
handle_response(t(), Grizzly.Packet.t()) ::
  {:continue, t()}
  | {:done, {:error, :nack_response}}
  | {:done, :ok}
  | {:retry, t()}
  | {:queued, t()}

Callback implementation for Grizzly.Command.handle_response/2.

Link to this function

init(opts) View Source
init([opts()]) :: {:ok, t()}

Callback implementation for Grizzly.Command.init/1.