Packages
grizzly
8.6.5
9.1.4
9.1.2
9.1.1
9.1.0
9.0.0
8.15.3
8.15.2
8.15.1
8.15.0
8.14.0
8.13.0
8.12.0
8.11.3
8.11.2
8.11.1
8.11.0
8.10.0
8.9.0
8.8.1
8.8.0
8.7.1
8.7.0
8.6.12
8.6.11
8.6.10
8.6.9
8.6.8
8.6.7
retired
8.6.6
8.6.5
8.6.4
8.6.3
8.6.2
8.6.1
8.6.0
8.5.3
8.5.2
8.5.1
8.5.0
8.4.0
8.3.0
8.2.3
8.2.2
8.2.1
8.2.0
8.1.0
8.0.1
8.0.0
7.4.3
7.4.2
7.4.1
7.4.0
7.3.0
7.2.0
7.1.4
7.1.3
7.1.2
7.1.1
7.1.0
7.0.4
7.0.3
7.0.2
7.0.1
7.0.0
6.8.8
6.8.7
6.8.6
6.8.5
6.8.4
6.8.3
6.8.2
6.8.1
6.8.0
6.7.1
6.7.0
6.6.1
6.6.0
6.5.1
6.5.0
6.4.0
6.3.0
6.2.0
6.1.1
6.1.0
6.0.1
6.0.0
5.4.1
5.4.0
5.3.0
5.2.8
5.2.7
5.2.6
5.2.5
5.2.4
5.2.3
5.2.2
5.2.1
5.2.0
5.1.2
5.1.1
5.1.0
5.0.2
5.0.1
5.0.0
4.0.1
4.0.0
3.0.0
2.1.0
2.0.0
1.0.1
1.0.0
0.22.7
0.22.6
0.22.5
0.22.4
0.22.3
0.22.2
0.22.1
0.22.0
0.21.1
0.21.0
0.20.2
0.20.1
0.20.0
0.19.1
0.19.0
0.18.3
0.18.2
0.18.1
0.18.0
0.17.7
0.17.6
0.17.5
0.17.4
0.17.3
0.17.2
0.17.1
0.17.0
0.16.2
0.16.1
0.16.0
0.15.11
0.15.10
0.15.9
0.15.8
0.15.7
0.15.6
0.15.5
0.15.4
0.15.3
0.15.2
0.15.1
0.15.0
0.14.8
0.14.7
0.14.6
0.14.5
0.14.4
0.14.3
0.14.2
0.14.1
0.14.0
0.13.0
0.12.3
0.12.2
0.12.1
0.12.0
0.11.0
0.10.3
0.10.2
0.10.1
0.10.0
0.9.0
0.9.0-rc.4
0.9.0-rc.3
0.9.0-rc.2
0.9.0-rc.1
0.9.0-rc.0
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.0
0.6.6
0.6.5
0.6.4
0.6.3
0.6.2
0.6.1
0.6.0
0.5.0
0.4.3
0.4.2
Elixir Z-Wave library
Current section
Files
Jump to
Current section
Files
lib/grizzly/zwave/node_id.ex
defmodule Grizzly.ZWave.NodeId do
@moduledoc false
# helper module for encoding and parsing node ids
alias Grizzly.ZWave
# When encoding for 16 bit node ids in the context of the node remove family of
# command (node ids > 255) the 8 bit node id byte of the binary needs to be set
# to 0xFF as per the specification.
# In ZWA_Z-Wave Network Protocol Command Class Specification 12.0.0.pdf:
# For example in sections 4.5.13.2 and 4.4.13.3:
# "This field MUST be set to 0xFF if the removed NodeID is greater than 255."
# This only is used for version 4 parsing and encoding.
@node_id_is_16_bit 0xFF
@doc """
Encode the node id
"""
@spec encode(ZWave.node_id()) :: binary()
def encode(node_id), do: <<node_id>>
@typedoc """
Options for extended format encoding
* `:delimiter` - when the 8 bit node id and 16 bit node id bytes do not follow
in sequence next to each other, this option allows the information between
the two formats to be passed.
"""
@type extended_encoding_opt() :: {:delimiter, binary()}
@doc """
Encode the node id using the extended node id format
The format for command classes that support extended node ids is:
```
<<0xFF, 16_bit_node_id>>
```
Or
```
<<8_bit_node_id, 16_bits_that_match_8_bit_node_id>>
```
When using the extended format encoding as passing an 8 bit node id the
specification often times states that the remaining 2 bytes at the end of the
binary must match the node id passed to the 8 bit node id byte. For example:
```elixir
iex> encode_extended(0x05)
<<0x05, 0x00, 0x05>>
```
Since the node id fits within the 8 bit node id field that is the first byte.
The next two bytes (16 bits) is that node id repeated within the 2 byte space
required to fill the total number of bytes for the extended format encoding.
When the 8 bit node id and the 16 bit node id bytes are not in sequence and
there other information between them you can pass the `:delimiter` option to
ensure that binary is in between the 8 bit node and the 16 bit node id bytes.
```elixir
iex> encode_extended(0x10, delimiter: <<0xA0, 0xB0>>)
<<0x10, 0xA0, 0xB0, 0x00, 0x10>>
iex> encode_extended(0x1010, delimiter: <<0xA0, 0xB0>>)
<<0xFF, 0xA0, 0xB0, 0x10, 0x10>>
```
"""
@spec encode_extended(ZWave.node_id(), [extended_encoding_opt()]) :: binary()
def encode_extended(node_ids, opts \\ [])
def encode_extended(node_id, opts) when node_id < 233 do
case Keyword.get(opts, :delimiter) do
nil ->
<<node_id, node_id::16>>
padding ->
<<node_id, padding::binary, node_id::16>>
end
end
def encode_extended(node_id, opts) when node_id > 255 and node_id <= 65535 do
case Keyword.get(opts, :delimiter) do
nil ->
<<@node_id_is_16_bit, node_id::16>>
padding ->
<<@node_id_is_16_bit, padding::binary, node_id::16>>
end
end
@typedoc """
Parsing options
* `:delimiter_size` - when the 8 bit node id and the 16 bit node are not in
sequence and are separated by bytes in between them you can specify the byte
size of the delimiter.
"""
@type parse_opt() :: {:delimiter_size, non_neg_integer()}
@doc """
Parse the binary that contains the node id
For node id binaries that support the extended node id format but contain
bytes in between the 8 bit node id byte and the 16 bit node id bytes the
options `:delimiter_size` can be passed to account for these in between
bytes in parsing.
"""
@spec parse(binary(), [parse_opt()]) :: ZWave.node_id()
def parse(node_id_binary, opts \\ [])
def parse(<<node_id>>, _opts), do: node_id
def parse(node_id_bin, opts) do
case Keyword.get(opts, :delimiter_size, 0) do
0 ->
do_parse(node_id_bin)
del_size ->
<<node_id_8, _delimiter::size(del_size)-unit(8), node_id_16::binary>> = node_id_bin
do_parse(<<node_id_8, node_id_16::binary>>)
end
end
defp do_parse(<<node_id>>), do: node_id
# sometimes packets will have extra bytes after the 16 bit node id, we can
# ignore those
defp do_parse(<<@node_id_is_16_bit, node_id::16, _ignore::binary>>), do: node_id
defp do_parse(<<node_id, _ignored::binary>>), do: node_id
end