5. Network-Protocol Command Classes

Table of Contents

• 5.1. Network-Protocol Command Class Overview
• 5.2. Network-Protocol Command Class Definitions
  • 5.2.1. Inclusion Controller Command Class, version 1
    • 5.2.1.1. Compatibility considerations
      • 5.2.1.1.1. Node information frame (NIF)
      • 5.2.1.1.2. Legacy controllers
    • 5.2.1.2. Inclusion controller initiate command
    • 5.2.1.3. Inclusion controller complete command
  • 5.2.2. IP Configuration Command Class, version 1
    • 5.2.2.1. IP configuration set command
    • 5.2.2.2. IP configuration get command
    • 5.2.2.3. IP configuration report command
    • 5.2.2.4. IP configuration DHCP release command
    • 5.2.2.5. IP configuration DHCP renew command
  • 5.2.3. Mailbox Command Class, version 1
    • 5.2.3.1. Mailbox framework
      • 5.2.3.1.1. Mailbox proxy
      • 5.2.3.1.2. Mailbox service
      • 5.2.3.1.3. Frame flow
    • 5.2.3.2. Mailbox configuration get command
    • 5.2.3.3. Mailbox configuration set command
    • 5.2.3.4. Mailbox configuration report command
    • 5.2.3.5. Mailbox queue command
    • 5.2.3.6. Mailbox wake up notification command
    • 5.2.3.7. Mailbox failing node command
    • 5.2.3.8. Frame flow diagrams Examples
  • 5.2.4. Mailbox Command Class, version 2
    • 5.2.4.1. Examples and frame flows
      • 5.2.4.1.1. Node interview process
  • 5.2.5. Network Management Command Classes
    • 5.2.5.1. Compatibility considerations
      • 5.2.5.1.1. Sequence number management
    • 5.2.5.2. Scope of network management
      • 5.2.5.2.1. Intranode
      • 5.2.5.2.2. Intranet (LAN)
      • 5.2.5.2.3. Internet (WAN)
    • 5.2.5.3. Security considerations
      • 5.2.5.3.1. Designing for single-threading and limited transmit buffer
    • 5.2.5.4. Network management proxy command class, version 1
      • 5.2.5.4.1. Node list get command
      • 5.2.5.4.2. Node list report command
      • 5.2.5.4.3. Node info cached get command
      • 5.2.5.4.4. Node info cached report command
    • 5.2.5.5. Network management proxy command class, version 2
      • 5.2.5.5.1. Compatibility considerations
      • 5.2.5.5.2. Node info cached report command
      • 5.2.5.5.3. Network management multi channel end point get command
      • 5.2.5.5.4. Network management multi channel end point report command
      • 5.2.5.5.5. Network management multi channel capability get command
      • 5.2.5.5.6. Network management multi channel capability report command
      • 5.2.5.5.7. Network management multi channel aggregated members get command
      • 5.2.5.5.8. Network management multi channel aggregated members report command
    • 5.2.5.6. Network management proxy command class, version 3
      • 5.2.5.6.1. Compatibility considerations
      • 5.2.5.6.2. Failed node list get command
      • 5.2.5.6.3. Failed node list report command
    • 5.2.5.7. Network management proxy command class, version 4
      • 5.2.5.7.1. Compatibility Considerations
      • 5.2.5.7.2. Node list report command
      • 5.2.5.7.3. Node info cached get command
      • 5.2.5.7.4. Network management multi channel end point get command
      • 5.2.5.7.5. Network management multi channel end point report command
      • 5.2.5.7.6. Network management multi channel capability get command
      • 5.2.5.7.7. Network management multi channel capability report command
      • 5.2.5.7.8. Network management multi channel aggregated members get command
      • 5.2.5.7.9. Network management multi channel aggregated members report command
      • 5.2.5.7.10. Failed node list report command
    • 5.2.5.8. Network Management Basic Node Command Class, version 1
      • 5.2.5.8.1. Default set command
      • 5.2.5.8.2. Default set complete command
      • 5.2.5.8.3. Learn mode set command
        • 5.2.5.8.3.1. Learn mode in a controller
      • 5.2.5.8.4. Learn mode set status command
      • 5.2.5.8.5. Node information send command
      • 5.2.5.8.6. Network update request command
      • 5.2.5.8.7. Network update request status command
      • 5.2.5.8.8. Use cases and frame flows
        • 5.2.5.8.8.1. Z/IP client requesting a node to interrupt Learn Mode
    • 5.2.5.9. Network management basic node command class, version 2
      • 5.2.5.9.1. Compatibility considerations
      • 5.2.5.9.2. Learn mode set command
      • 5.2.5.9.3. Learn mode set status command
      • 5.2.5.9.4. DSK get command
      • 5.2.5.9.5. DSK Report Command
      • 5.2.5.9.6. Use cases and frame flows
        • 5.2.5.9.6.1. Z/IP Client requesting a node to report node interview status
    • 5.2.5.10. Network management inclusion command class, version 1
      • 5.2.5.10.1. Node add command
      • 5.2.5.10.2. Node add status command
      • 5.2.5.10.3. Node remove command
      • 5.2.5.10.4. Node remove status command
      • 5.2.5.10.5. Failed node remove command
      • 5.2.5.10.6. Node neighbor update request command
      • 5.2.5.10.7. Node neighbor update status command
      • 5.2.5.10.8. Return route assign command
      • 5.2.5.10.9. Return route assign complete command
      • 5.2.5.10.10. Return route delete command
      • 5.2.5.10.11. Return route delete complete command
      • 5.2.5.10.12. Use cases and frame flows
        • 5.2.5.10.12.1. Z/IP Client requesting a node to interrupt Add Mode
    • 5.2.5.11. Network management inclusion command class, version 2
      • 5.2.5.11.1. Compatibility considerations
      • 5.2.5.11.2. Node add command
      • 5.2.5.11.3. Node add status command
      • 5.2.5.11.4. Node add keys report command
      • 5.2.5.11.5. Node add DSK report command
      • 5.2.5.11.6. Node add DSK set command
      • 5.2.5.11.7. Failed node replace command
      • 5.2.5.11.8. Failed node replace status command
      • 5.2.5.11.9. Use cases and frame flows
        • 5.2.5.11.9.1. Z/IP Client with SIS or Primary controller including an S2 node
        • 5.2.5.11.9.2. Z/IP Client with an S2 inclusion controller including an S2 node
        • 5.2.5.11.9.3. Z/IP client with an S2 inclusion controller including an S0 node
    • 5.2.5.12. Network management inclusion command class, version 3
      • 5.2.5.12.1. Compatibility considerations
        • 5.2.5.12.1.1. Command class dependencies
      • 5.2.5.12.2. Node add status command
      • 5.2.5.12.3. Included node information frame report command
      • 5.2.5.12.4. Smart start join started command
      • 5.2.5.12.5. Usage and frame flows
        • 5.2.5.12.5.1. Z/IP Gateway adding a smart start node that is on the provisioning list
        • 5.2.5.12.5.2. Z/IP Gateway adding a smart start node that is subsequently added on the provisioning list
        • 5.2.5.12.5.3. Z/IP Gateway receiving an INIF from a node (the provisioning list) included in another network
        • 5.2.5.12.5.4. Z/IP Gateway including an S2 only node that is on the provisioning list
    • 5.2.5.13. Network management inclusion command class, version 4
      • 5.2.5.13.1. Compatibility considerations
        • 5.2.5.13.1.1. Command class dependencies
      • 5.2.5.13.2. Failed node remove command
      • 5.2.5.13.3. Failed node remove status command
      • 5.2.5.13.4. Extended node add status command
      • 5.2.5.13.5. Usage and frame flows
        • 5.2.5.13.5.1. Z/IP Gateway including a SmartStart with extended nodeID
    • 5.2.5.14. Network management primary command class, version 1 [OBSOLETED]
      • 5.2.5.14.1. Controller change command
      • 5.2.5.14.2. Controller change status command
    • 5.2.5.15. Network management installation and maintenance command class, version 1
      • 5.2.5.15.1. Priority route set
      • 5.2.5.15.2. Priority route get
      • 5.2.5.15.3. Priority route report
      • 5.2.5.15.4. Statistics get
      • 5.2.5.15.5. Statistics report
        • 5.2.5.15.5.1. Route changes (RC)
        • 5.2.5.15.5.2. Transmission Count (TC)
        • 5.2.5.15.5.3. Neighbors (NB)
        • 5.2.5.15.5.4. Packet error count (PEC)
        • 5.2.5.15.5.5. Sum of transmission times squared (TS2)
      • 5.2.5.15.6. Statistics clear
      • 5.2.5.15.7. Use cases
        • 5.2.5.15.7.1. Intranode network management: TV OSD system controlling lamps
        • 5.2.5.15.7.2. Intranet network management: remote controlling a primary controller
        • 5.2.5.15.7.3. Internet network management #1: call-center support for TV OSD user
        • 5.2.5.15.7.4. Traffic flow: gathering node information
    • 5.2.5.16. Network management installation and maintenance command class, version 2
      • 5.2.5.16.1. Compatibility considerations
      • 5.2.5.16.2. RSSI get command
      • 5.2.5.16.3. RSSI report command
    • 5.2.5.17. Network management installation and maintenance command class, version 3
      • 5.2.5.17.1. Compatibility considerations
      • 5.2.5.17.2. S2 resynchronization event command
      • 5.2.5.17.3. Extended statistics get
      • 5.2.5.17.4. Extended statistics report
    • 5.2.5.18. Network management installation and maintenance command class, version 4
      • 5.2.5.18.1. Compatibility considerations
      • 5.2.5.18.2. RSSI report command
      • 5.2.5.18.3. Z-Wave long range channel configuration set
      • 5.2.5.18.4. Z-Wave long range channel configuration get
      • 5.2.5.18.5. Z-Wave long range channel configuration report
  • 5.2.6. No Operation Command Class, version 1
  • 5.2.7. Node Provisioning Command Class, version 1
    • 5.2.7.1. Terminology
    • 5.2.7.2. Compatibility considerations
    • 5.2.7.3. Security considerations
    • 5.2.7.4. Node Provisioning Set Command
    • 5.2.7.5. Node Provisioning Delete Command
    • 5.2.7.6. Node Provisioning Get Command
    • 5.2.7.7. Node Provisioning Report Command
    • 5.2.7.8. Node Provisioning List Iteration Get Command
    • 5.2.7.9. Node Provisioning List Iteration Report Command
    • 5.2.7.10. Meta Data Extension Format
    • 5.2.7.11. Usage and Frame Flows
      • 5.2.7.11.1. Z/IP Client requesting the entire Node Provisioning list.
  • 5.2.8. Powerlevel Command Class, version 1
    • 5.2.8.1. Powerlevel Set Command
    • 5.2.8.2. Powerlevel Get Command
    • 5.2.8.3. Powerlevel Report Command
    • 5.2.8.4. Powerlevel Test Node Set Command
    • 5.2.8.5. Powerlevel Test Node Get Command
    • 5.2.8.6. Powerlevel Test Node Report Command
  • 5.2.9. Z/IP Command Class, version 1
  • 5.2.10. Z/IP Command Class, version 2
    • 5.2.10.1. Security considerations
    • 5.2.10.2. Interoperability considerations
    • 5.2.10.3. Z/IP Packet Command
  • 5.2.11. Z/IP Command Class, version 3
    • 5.2.11.1. Compatibility considerations
    • 5.2.11.2. Z/IP Packet Command
  • 5.2.12. Z/IP Command Class, version 4
    • 5.2.12.1. Compatibility considerations
    • 5.2.12.2. Z/IP Keep Alive Command
  • 5.2.13. Z/IP Command Class, version 5
    • 5.2.13.1. Compatibility considerations
    • 5.2.13.2. List of defined Z/IP Packet Options
      • 5.2.13.2.1. Expected Delay Option
      • 5.2.13.2.2. Installation and Maintenance Get Option
      • 5.2.13.2.3. Installation and Maintenance Report Option
        • 5.2.13.2.3.1. Route Changed (3 bytes)
        • 5.2.13.2.3.2. Transmission Time (4 bytes)
        • 5.2.13.2.3.3. Last Working Route (7 bytes)
        • 5.2.13.2.3.4. ACK channel (3 bytes)
        • 5.2.13.2.3.5. Transmit channel (3 bytes)
        • 5.2.13.2.3.6. Routing scheme (3 bytes)
        • 5.2.13.2.3.7. Routing attempts (3 bytes)
        • 5.2.13.2.3.8. Failed link (4 bytes)
        • 5.2.13.2.3.9. Tx Power (2 bytes)
        • 5.2.13.2.3.10. Measured Noise Floor (2 bytes)
        • 5.2.13.2.3.11. Outgoing RSSI (7 bytes)
      • 5.2.13.2.4. Encapsulation Format Information Option
      • 5.2.13.2.5. Z-Wave Multicast Addressing Option
  • 5.2.14. Z/IP 6LoWPAN Command Class, version 1
  • 5.2.15. Z/IP Gateway Comand Class, version 1
    • 5.2.15.1. Interoperability considerations
    • 5.2.15.2. Gateway Mode Set Command
    • 5.2.15.3. Gateway Mode Get Command
    • 5.2.15.4. Gateway Mode Report Command
    • 5.2.15.5. Gateway Peer Set Command
    • 5.2.15.6. Gateway Peer Get Command
    • 5.2.15.7. Gateway Peer Report Command
    • 5.2.15.8. Gateway Lock Set Command
    • 5.2.15.9. Unsolicited Destination Set Command
    • 5.2.15.10. Unsolicited Destination Get Command
    • 5.2.15.11. Unsolicited Destination Report Command
    • 5.2.15.12. Application Node Info Set Command
    • 5.2.15.13. Application Node Info Get Command
    • 5.2.15.14. Application Node Info Report Command
  • 5.2.16. Z/IP ND Command Class, version 1
    • 5.2.16.1. Interoperability considerations
    • 5.2.16.2. Security considerations
    • 5.2.16.3. Z/IP Node Solicitation Command
    • 5.2.16.4. Z/IP Inverse Node Solicitation Command
    • 5.2.16.5. Z/IP Node Advertisement Command
  • 5.2.17. Z/IP ND Command Class, version 2
    • 5.2.17.1. Compatibility Considerations
    • 5.2.17.2. Interoperability considerations
    • 5.2.17.3. Security considerations
    • 5.2.17.4. Z/IP Inverse Node Solicitation Command
    • 5.2.17.5. Z/IP Node Advertisement Command
  • 5.2.18. Z/IP Portal Command Class, version 1
    • 5.2.18.1. Interoperability considerations
      • 5.2.18.1.1. On the use of Z/IP Gateway and Z/IP Portal command classes
    • 5.2.18.2. Gateway Configuration Set Command
    • 5.2.18.3. Gateway Configuration Status
    • 5.2.18.4. Gateway Configuration Get Command
    • 5.2.18.5. Gateway Configuration Report Command:
    • 5.2.18.6. Gateway Unregister Command