Revert removing the listening? node info property

It was removed on the basis of the Z-Wave documentation at "5.2.5.4.4. Node info cached report" describing the `List.` bit as

```
List (1 bit)The Optional Functionality bit indicates if true ( == '1') the node supports more command classes in addition to
the ones covered by the device classes listed in this message. The additional command classes follow the device class fields.
```

The official documentation is wrong here. The `List` bit does indicate whether or not the device is "mains powered" and thus constantly
listening. See "2.1.4.2. Application Specific Part" in the Z-Wave documentation for a description of the `listening` flag which value is
the same as the `List.` bit in the Node Info Cached Report command.

Author: jfcloutier

lib/grizzly/virtual_devices/reports.ex

@@ -30,6 +30,7 @@ defmodule Grizzly.VirtualDevices.Reports do
         seq_number: 0x00,
         node_id: device_entry.id,
         status: :done,
+        listening?: true,
         basic_device_class: device_entry.device_class.basic_device_class,
         generic_device_class: device_entry.device_class.generic_device_class,
         specific_device_class: device_entry.device_class.specific_device_class,
@@ -77,6 +78,7 @@ defmodule Grizzly.VirtualDevices.Reports do
         seq_number: seq_number,
         status: :ok,
         age: 1,
+        listening?: true,
         command_classes: command_classes_for_device(entry.device_class),
         basic_device_class: entry.device_class.basic_device_class,
         specific_device_class: entry.device_class.specific_device_class,

lib/grizzly/zwave/command_classes/network_management_inclusion.ex

@@ -75,6 +75,7 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusion do
 
   node information from a node add status report
 
+  * `:listening?` - is the device a listening device
   * `:basic_device_class` - the basic device class
   * `:generic_device_class` - the generic device class
   * `:specific_device_class` - the specific device class
@@ -89,6 +90,7 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusion do
           required(:seq_number) => byte(),
           required(:node_id) => Grizzly.ZWave.node_id(),
           required(:status) => node_add_status(),
+          required(:listening?) => boolean(),
           required(:basic_device_class) => DeviceClasses.basic_device_class(),
           required(:generic_device_class) => DeviceClasses.generic_device_class(),
           required(:specific_device_class) => DeviceClasses.specific_device_class(),
@@ -103,6 +105,7 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusion do
 
   Node information from an extended node add status report
 
+  * `:listening?` - is the device a listening device
   * `:basic_device_class` - the basic device class
   * `:generic_device_class` - the generic device class
   * `:specific_device_class` - the specific device class
@@ -111,6 +114,7 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusion do
   * `:kex_fail_type` - the type of key exchange failure if there is one
   """
   @type extended_node_info_report() :: %{
+          required(:listening?) => boolean(),
           required(:basic_device_class) => DeviceClasses.basic_device_class(),
           required(:generic_device_class) => DeviceClasses.generic_device_class(),
           required(:specific_device_class) => DeviceClasses.specific_device_class(),
@@ -124,7 +128,7 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusion do
   """
   @spec parse_node_info(binary()) :: node_info_report() | extended_node_info_report()
   def parse_node_info(
-        <<node_info_length, _extra_ccs?::1, _::7, _opt_func, basic_device_class,
+        <<node_info_length, listening?::1, _::7, _opt_func, basic_device_class,
           generic_device_class, specific_device_class,
           command_classes::binary-size(node_info_length - 6), rest::binary>>
       ) do
@@ -141,11 +145,12 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusion do
         specific_device_class
       )
 
-    # node info length includes: node_info_length, extra_ccs?, opt_func, basic class,
+    # node info length includes: node_info_length, listening?, opt_func, basic class,
     # generic class, specific class, and the command class list. Granted keys, kex fail
     # type, and DSK are not included.
 
     %{
+      listening?: listening? == 1,
       basic_device_class: basic_device_class,
       generic_device_class: generic_device_class,
       specific_device_class: specific_device_class,

lib/grizzly/zwave/commands/extended_node_add_status.ex

@@ -10,6 +10,7 @@ defmodule Grizzly.ZWave.Commands.ExtendedNodeAddStatus do
     * `:seq_number` - the sequence number of the inclusion command
     * `:status` - the status of the inclusion
     * `:node_id` - the new id of the new Z-Wave node
+    * `:listening?` - if the node is a listening node or not
     * `:basic_device_class` - the Z-Wave basic device class
     * `:generic_device_class` - the Z-Wave generic device class
     * `:specific_device_class` - the Z-Wave specific device class
@@ -34,6 +35,7 @@ defmodule Grizzly.ZWave.Commands.ExtendedNodeAddStatus do
           {:node_id, Grizzly.node_id()}
           | {:status, NetworkManagementInclusion.node_add_status()}
           | {:seq_number, Grizzly.seq_number()}
+          | {:listening?, boolean()}
           | {:basic_device_class, byte()}
           | {:generic_device_class, byte()}
           | {:specific_device_class, byte()}
@@ -66,22 +68,22 @@ defmodule Grizzly.ZWave.Commands.ExtendedNodeAddStatus do
     if status == :failed do
       <<seq_number, status_byte, node_id::16, 0x01>>
     else
+      listening? = Command.param!(command, :listening?)
       basic_device_class = Command.param!(command, :basic_device_class)
       generic_device_class = Command.param!(command, :generic_device_class)
       specific_device_class = Command.param!(command, :specific_device_class)
       command_classes = Command.param!(command, :command_classes)
-      extra_ccs? = not Enum.empty?(command_classes)
 
       # We add 6 to the length of the command classes to account for the 3 device
       # classes 2 Z-Wave protocol bytes and the node info length byte.
       # Also add the number of command classes plus 4 bytes for the separators
       # See SDS13784 4.4.8.2 for more details
       node_info_length = 6 + cc_count(command_classes)
 
-      extra_ccs_bit = if extra_ccs?, do: 1, else: 0
+      listening_bit = if listening?, do: 1, else: 0
 
-      # TODO: fix opt func bit (after the extra_ccs bit)
-      <<seq_number, status_byte, node_id::16, node_info_length, extra_ccs_bit::1, 0x00::7, 0x00,
+      # TODO: fix opt func bit (after the listening bit)
+      <<seq_number, status_byte, node_id::16, node_info_length, listening_bit::1, 0x00::7, 0x00,
         basic_device_class, generic_device_class,
         specific_device_class>> <>
         CommandClasses.command_class_list_to_binary(command_classes) <>
@@ -111,6 +113,7 @@ defmodule Grizzly.ZWave.Commands.ExtendedNodeAddStatus do
        status: NetworkManagementInclusion.parse_node_add_status(status_byte),
        seq_number: seq_number,
        node_id: node_id,
+       listening?: false,
        basic_device_class: :unknown,
        generic_device_class: :unknown,
        specific_device_class: :unknown,

lib/grizzly/zwave/commands/node_add_status.ex

@@ -9,6 +9,7 @@ defmodule Grizzly.ZWave.Commands.NodeAddStatus do
     * `:seq_number` - the sequence number of the inclusion command
     * `:status` - the status of the inclusion
     * `:node_id` - the new id of the new Z-Wave node
+    * `:listening?` - if the node is a listening node or not
     * `:basic_device_class` - the Z-Wave basic device class
     * `:generic_device_class` - the Z-Wave generic device class
     * `:specific_device_class` - the Z-Wave specific device class
@@ -34,6 +35,7 @@ defmodule Grizzly.ZWave.Commands.NodeAddStatus do
           {:node_id, Grizzly.node_id() | Grizzly.VirtualDevices.id()}
           | {:status, NMI.node_add_status()}
           | {:seq_number, Grizzly.seq_number()}
+          | {:listening?, boolean()}
           | {:basic_device_class, byte()}
           | {:generic_device_class, byte()}
           | {:specific_device_class, byte()}
@@ -66,22 +68,22 @@ defmodule Grizzly.ZWave.Commands.NodeAddStatus do
     if status == :failed do
       <<seq_number, NMI.node_add_status_to_byte(status), 0x00, node_id, 0x01>>
     else
-      command_classes = Command.param(command, :command_classes, [])
-      extra_ccs? = not Enum.empty?(command_classes)
+      listening? = Command.param!(command, :listening?)
       basic_device_class = Command.param!(command, :basic_device_class)
       generic_device_class = Command.param!(command, :generic_device_class)
       specific_device_class = Command.param!(command, :specific_device_class)
+      command_classes = Command.param(command, :command_classes, [])
 
       # We add 6 to the length of the command classes to account for the 3 device
       # classes 2 Z-Wave protocol bytes and the node info length byte.
       # Also add the number of command classes plus 4 bytes for the separators
       # See SDS13784 4.4.8.2 for more details
       node_info_length = 6 + cc_count(command_classes)
 
-      # TODO: fix opt func bit (after the extra_ccs bit)
+      # TODO: fix opt func bit (after the listening bit)
       binary =
         <<seq_number, NMI.node_add_status_to_byte(status), 0x00, node_id, node_info_length,
-          encode_extra_ccs_bit(extra_ccs?)::size(1), 0x00::7, 0x00,
+          encode_listening_bit(listening?)::size(1), 0x00::7, 0x00,
           DeviceClasses.basic_device_class_to_byte(basic_device_class),
           DeviceClasses.generic_device_class_to_byte(generic_device_class),
           DeviceClasses.specific_device_class_to_byte(generic_device_class, specific_device_class)>> <>
@@ -98,6 +100,7 @@ defmodule Grizzly.ZWave.Commands.NodeAddStatus do
        status: NMI.parse_node_add_status(status_byte),
        seq_number: seq_number,
        node_id: node_id,
+       listening?: false,
        basic_device_class: :unknown,
        generic_device_class: :unknown,
        specific_device_class: :unknown,
@@ -120,9 +123,9 @@ defmodule Grizzly.ZWave.Commands.NodeAddStatus do
     {:ok, params}
   end
 
-  @spec encode_extra_ccs_bit(boolean()) :: byte()
-  def encode_extra_ccs_bit(true), do: 0x01
-  def encode_extra_ccs_bit(false), do: 0x00
+  @spec encode_listening_bit(boolean()) :: byte()
+  def encode_listening_bit(true), do: 0x01
+  def encode_listening_bit(false), do: 0x00
 
   defp maybe_add_version_2_fields(command, command_bin) do
     case Command.param(command, :granted_keys) do

lib/grizzly/zwave/commands/node_info_cached_report.ex

@@ -11,7 +11,8 @@ defmodule Grizzly.ZWave.Commands.NodeInfoCacheReport do
   - `:status` - the status fo the node information (required)
   - `:age` - the age of the cache data. A number that is expressed `2 ^ n`
     minutes (required)
-  - `:command_classes` - a list of lists of command classes tagged by security attributes, in addition to those implied by the device classes (optional default empty
+  - `:listening?` - if the node is listening node or sleeping node (required)
+  - `:command_classes` - a list of lists of command classes tagged by security attributes (optional default empty
     list)
   - `:basic_device_class` - the basic device class (required)
   - `:generic_device_class` - the generic device class (required)
@@ -20,6 +21,7 @@ defmodule Grizzly.ZWave.Commands.NodeInfoCacheReport do
   @behaviour Grizzly.ZWave.Command
 
   import Bitwise
+  import Grizzly.ZWave.Encoding
 
   alias Grizzly.ZWave.Command
   alias Grizzly.ZWave.CommandClasses.NetworkManagementProxy
@@ -46,6 +48,7 @@ defmodule Grizzly.ZWave.Commands.NodeInfoCacheReport do
           {:seq_number, Grizzly.seq_number()}
           | {:status, status()}
           | {:age, 1..14}
+          | {:listening?, boolean()}
           | {:command_classes, [tagged_command_classes]}
           | {:basic_device_class, DeviceClasses.basic_device_class()}
           | {:generic_device_class, DeviceClasses.generic_device_class()}
@@ -71,8 +74,8 @@ defmodule Grizzly.ZWave.Commands.NodeInfoCacheReport do
     seq_number = Command.param!(command, :seq_number)
     status_byte = encode_status(Command.param!(command, :status))
     age = Command.param!(command, :age)
+    listening_byte = encode_listening?(Command.param!(command, :listening?))
     command_classes = Command.param!(command, :command_classes)
-    extra_ccs_byte = encode_extra_ccs(not Enum.empty?(command_classes))
 
     basic_device_class_byte =
       DeviceClasses.basic_device_class_to_byte(Command.param!(command, :basic_device_class))
@@ -88,14 +91,14 @@ defmodule Grizzly.ZWave.Commands.NodeInfoCacheReport do
     optional_functionality_byte = encode_optional_functionality_byte(command_classes)
 
     # the `0x00` byte is a reserved byte for Z-Wave and must be set to 0x00
-    <<seq_number, status_byte ||| age, extra_ccs_byte, optional_functionality_byte, 0x00,
+    <<seq_number, status_byte ||| age, listening_byte, optional_functionality_byte, 0x00,
       basic_device_class_byte, DeviceClasses.generic_device_class_to_byte(generic_device_class),
       specific_device_class_byte>> <> CommandClasses.command_class_list_to_binary(command_classes)
   end
 
   @impl Grizzly.ZWave.Command
   def decode_params(
-        <<seq_number, status::4, age::4, _extra_ccs?::1, _::7, _, _keys, basic_device_class_byte,
+        <<seq_number, status::4, age::4, list?::1, _::7, _, _keys, basic_device_class_byte,
           generic_device_class_byte, specific_device_class_byte, command_classes::binary>>
       ) do
     {:ok, basic_device_class} =
@@ -116,6 +119,7 @@ defmodule Grizzly.ZWave.Commands.NodeInfoCacheReport do
        basic_device_class: basic_device_class,
        generic_device_class: generic_device_class,
        specific_device_class: specific_device_class,
+       listening?: bit_to_bool(list?),
        command_classes: CommandClasses.command_class_list_from_binary(command_classes),
        status: decode_status(status),
        age: age
@@ -125,8 +129,8 @@ defmodule Grizzly.ZWave.Commands.NodeInfoCacheReport do
   def encode_status(_), do: 0
   def encode_command_classes(_), do: 0
 
-  def encode_extra_ccs(true), do: 0x80
-  def encode_extra_ccs(false), do: 0x00
+  def encode_listening?(true), do: 0x80
+  def encode_listening?(false), do: 0x00
 
   def encode_optional_functionality_byte([]), do: 0x00
   def encode_optional_functionality_byte(_), do: 0x80

test/grizzly/zipgateway/ready_checker_test.exs

@@ -30,7 +30,7 @@ defmodule Grizzly.ZIPGateway.ReadyCheckerTest do
     ready_checker = start_supervised!({ReadyChecker, [name: ctx.test, status_reporter: on_ready]})
 
     send(ready_checker, @report)
-    assert_receive :received_ready, 1_000
+    assert_receive :received_ready
   end
 
   test "exception in callback does not crash ReadyChecker", ctx do

test/grizzly/zwave/command_classes/network_management_inclusion_test.exs

@@ -35,7 +35,7 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusionTest do
   describe "parsing node information" do
     test "version 1 - only a list of command classes" do
       node_info_bin =
-        <<0x10, 0x80, 0x00, 0x01, 0x02, 0x03, 0x20, 0x32, 0xEF, 0xF1, 0x00, 0x71, 0x25, 0xEF,
+        <<0x10, 0x00, 0x00, 0x01, 0x02, 0x03, 0x20, 0x32, 0xEF, 0xF1, 0x00, 0x71, 0x25, 0xEF,
           0x62, 0x63>>
 
       expected_command_classes = [
@@ -49,13 +49,14 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusionTest do
                command_classes: expected_command_classes,
                basic_device_class: :controller,
                generic_device_class: :static_controller,
+               listening?: false,
                specific_device_class: :static_installer_tool
              }
     end
 
     test "version 2 - adds S2 key values" do
       node_info_bin =
-        <<0x10, 0x80, 0x00, 0x01, 0x02, 0x03, 0x20, 0x32, 0xEF, 0xF1, 0x00, 0x71, 0x25, 0xEF,
+        <<0x10, 0x00, 0x00, 0x01, 0x02, 0x03, 0x20, 0x32, 0xEF, 0xF1, 0x00, 0x71, 0x25, 0xEF,
           0x62, 0x63, 0x07, 0x00>>
 
       expected_command_classes = [
@@ -69,6 +70,7 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusionTest do
                command_classes: expected_command_classes,
                basic_device_class: :controller,
                generic_device_class: :static_controller,
+               listening?: false,
                specific_device_class: :static_installer_tool,
                kex_fail_type: :none,
                granted_keys: [:s2_access_control, :s2_authenticated, :s2_unauthenticated]
@@ -77,7 +79,7 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusionTest do
 
     test "version 3 - adds input DSK field - when DSK is empty" do
       node_info_bin =
-        <<0x10, 0x80, 0x00, 0x01, 0x02, 0x03, 0x20, 0x32, 0xEF, 0xF1, 0x00, 0x71, 0x25, 0xEF,
+        <<0x10, 0x00, 0x00, 0x01, 0x02, 0x03, 0x20, 0x32, 0xEF, 0xF1, 0x00, 0x71, 0x25, 0xEF,
           0x62, 0x63, 0x07, 0x00, 0x00>>
 
       expected_command_classes = [
@@ -91,6 +93,7 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusionTest do
                command_classes: expected_command_classes,
                basic_device_class: :controller,
                generic_device_class: :static_controller,
+               listening?: false,
                specific_device_class: :static_installer_tool,
                kex_fail_type: :none,
                granted_keys: [:s2_access_control, :s2_authenticated, :s2_unauthenticated]
@@ -99,7 +102,7 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusionTest do
 
     test "version 3 - adds input DSK field - when DSK is provided" do
       node_info_bin =
-        <<0x10, 0x80, 0x00, 0x01, 0x02, 0x03, 0x20, 0x32, 0xEF, 0xF1, 0x00, 0x71, 0x25, 0xEF,
+        <<0x10, 0x00, 0x00, 0x01, 0x02, 0x03, 0x20, 0x32, 0xEF, 0xF1, 0x00, 0x71, 0x25, 0xEF,
           0x62, 0x63, 0x07, 0x00, 0x10, 0xC4, 0x6D, 0x49, 0x83, 0x26, 0xC4, 0x77, 0xE3, 0x3E,
           0x65, 0x83, 0xAF, 0xF, 0xA5, 0xE, 0x27>>
 
@@ -116,6 +119,7 @@ defmodule Grizzly.ZWave.CommandClasses.NetworkManagementInclusionTest do
                command_classes: expected_command_classes,
                basic_device_class: :controller,
                generic_device_class: :static_controller,
+               listening?: false,
                specific_device_class: :static_installer_tool,
                kex_fail_type: :none,
                granted_keys: [:s2_access_control, :s2_authenticated, :s2_unauthenticated],

test/grizzly/zwave/commands/extended_node_add_status_test.exs

@@ -35,6 +35,7 @@ defmodule Grizzly.ZWave.Commands.ExtendedNodeAddStatusTest do
         command_classes: expected_command_classes,
         basic_device_class: :controller,
         generic_device_class: :static_controller,
+        listening?: false,
         specific_device_class: :static_installer_tool,
         kex_fail_type: :none,
         granted_keys: [:s2_access_control, :s2_authenticated, :s2_unauthenticated]

test/grizzly/zwave/commands/node_add_status_test.exs

@@ -25,6 +25,7 @@ defmodule Grizzly.ZWave.Commands.NodeAddStatusTest do
         command_classes: expected_command_classes,
         basic_device_class: :controller,
         generic_device_class: :static_controller,
+        listening?: false,
         specific_device_class: :static_installer_tool
       ]
 
@@ -54,6 +55,7 @@ defmodule Grizzly.ZWave.Commands.NodeAddStatusTest do
         command_classes: expected_command_classes,
         basic_device_class: :controller,
         generic_device_class: :static_controller,
+        listening?: false,
         specific_device_class: :static_installer_tool,
         kex_fail_type: :none,
         granted_keys: [:s2_access_control, :s2_authenticated, :s2_unauthenticated]
@@ -88,6 +90,7 @@ defmodule Grizzly.ZWave.Commands.NodeAddStatusTest do
         command_classes: expected_command_classes,
         basic_device_class: :controller,
         generic_device_class: :static_controller,
+        listening?: false,
         specific_device_class: :static_installer_tool,
         kex_fail_type: :none,
         granted_keys: [:s2_access_control, :s2_authenticated, :s2_unauthenticated],
@@ -137,6 +140,7 @@ defmodule Grizzly.ZWave.Commands.NodeAddStatusTest do
         status: :failed,
         node_id: 7,
         seq_number: 37,
+        listening?: false,
         basic_device_class: :routing_end_node,
         generic_device_class: :sensor_notification,
         specific_device_class: :notification_sensor,