Grizzly.ZWave.SmartStart.MetaExtension.MaxInclusionRequestInterval (grizzly v0.15.6) View Source

This is used to advertise if a power constrained Smart Start node will issue inclusion request at a higher interval value than the default 512 seconds.

Link to this section Summary

Types

The interval (in seconds) must be in the range of 640..12672 inclusive, and has to be in steps of 128 seconds.

t()

Functions

Make a MaxInclusionRequestInterval.t() from a binary string

Make a binary string from a MaxInclusionRequestInterval.t()

Link to this section Types

Specs

interval() :: 640..12672

The interval (in seconds) must be in the range of 640..12672 inclusive, and has to be in steps of 128 seconds.

So after 640 the next valid interval is 640 + 128 which is 768 seconds.

See SDS13944 Node Provisioning Information Type Registry.pdf section 3.1.2.3 for more information.

Specs

t() :: %Grizzly.ZWave.SmartStart.MetaExtension.MaxInclusionRequestInterval{
  interval: interval()
}

Link to this section Functions

Specs

from_binary(binary()) ::
  {:ok, t()}
  | {:error,
     :interval_too_big
     | :interval_too_small
     | :critical_bit_set
     | :invalid_binary}

Make a MaxInclusionRequestInterval.t() from a binary string

If the interval provided in the binary is invalid this function will return {:error, :interval_too_big | :interval_too_small}. See the typedoc for more information regarding the interval specification.

If the critical bit is set this is considered invalid to the specification and the function will return {:error, :critical_bit_set}.

Specs

new(interval()) ::
  {:ok, t()}
  | {:error,
     :interval_too_small
     | :interval_too_big
     | :interval_step_invalid
     | :interval_required}
Link to this function

to_binary(max_inclusion_request_interval)

View Source

Specs

to_binary(t()) :: {:ok, binary()}

Make a binary string from a MaxInclusionRequestInterval.t()

If the interval provided in the binary is invalid this function will return {:error, :interval_too_big | :interval_too_small}. See the typedoc for more information regarding the interval specification.