grizzly v0.6.0 Grizzly.CommandClass.Configuration.BulkGet View Source

Command module for working with the Configuration command class BULK_GET command

Command Options:

  • :start - the starting number of the configuration params
  • :number - the number of params to get
  • :seq_number the sequence number used by Z/IP packet
  • :parameter_values - a list of the parameter values that are returned from Z-Wave
  • :acked - if there the command has successfully acked by Z-Wave
  • :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

opt() View Source
opt() ::
  {:start, integer()}
  | {:number, byte()}
  | {:seq_number, Grizzly.seq_number()}
  | {:retries, non_neg_integer()}

Link to this type

t() View Source
t() :: %Grizzly.CommandClass.Configuration.BulkGet{
  acked: boolean(),
  number: byte(),
  parameter_values: [],
  retries: non_neg_integer(),
  seq_number: Grizzly.seq_number(),
  start: integer()
}

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, %{start: any(), values: any()}}}
  | {:queued, t()}
  | {: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.