grizzly v0.8.0 Grizzly.CommandClass.UserCode.Get View Source

Command module for working with USER_CODE GET command

command options:

  • :slot_id - The slot id of the user code
  • :seq_number - The sequence number for the Z/IP Packet
  • :retries - The number times to retry to send the command (default 2)

Link to this section Summary

Link to this section Types

Link to this type

t() View Source
t() :: %Grizzly.CommandClass.UserCode.Get{
  retries: non_neg_integer(),
  seq_number: Grizzly.seq_number(),
  slot_id: Grizzly.CommandClass.UserCode.slot_id()
}

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, arg2) View Source
handle_response(t(), Grizzly.Packet.t()) ::
  {:continue, t()}
  | {:done, {:error, :nack_response}}
  | {:done, Grizzly.CommandClass.UserCode.user_code()}
  | {:retry, t()}

Callback implementation for Grizzly.Command.handle_response/2.

Link to this function

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

Callback implementation for Grizzly.Command.init/1.