bluetooth_mesh.messages

bluetooth_mesh.messages.AccessMessage = <_AccessMessage>

Config

class bluetooth_mesh.messages.config.ConfigOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.config.ConfigMessage = <SwitchStruct <Struct>>
  • opcode: : UNKNOWN

  • params: Switch by opcode
    • ConfigOpcode.CONFIG_APPKEY_ADD
      • app_key_index: Uint12

      • net_key_index: Uint12

      • app_key: bytes[16]

    • ConfigOpcode.CONFIG_APPKEY_DELETE
      • app_key_index: Uint12

      • net_key_index: Uint12

    • ConfigOpcode.CONFIG_APPKEY_GET
      • net_key_index: Uint12

    • ConfigOpcode.CONFIG_APPKEY_LIST
      • status: Enum of StatusCode as Uint8

      • net_key_index: Uint12

      • app_key_indices: Range of Uint12

    • ConfigOpcode.CONFIG_APPKEY_STATUS
      • status: Enum of StatusCode as Uint8

      • app_key_index: Uint12

      • net_key_index: Uint12

    • ConfigOpcode.CONFIG_APPKEY_UPDATE
      • app_key_index: Uint12

      • net_key_index: Uint12

      • app_key: bytes[16]

    • ConfigOpcode.CONFIG_BEACON_GET

    • ConfigOpcode.CONFIG_BEACON_SET
      • beacon: Enum of SecureNetworkBeacon as Uint8

    • ConfigOpcode.CONFIG_BEACON_STATUS
      • beacon: Enum of SecureNetworkBeacon as Uint8

    • ConfigOpcode.CONFIG_COMPOSITION_DATA_GET
      • page: Enum of CompositionDataPage as Uint8

    • ConfigOpcode.CONFIG_COMPOSITION_DATA_STATUS
      • page: Enum of CompositionDataPage as Uint8

      • data: Switch by page
        • CompositionDataPage.ZERO
          • cid: Uint16

          • pid: Uint16

          • vid: Uint16

          • crpl: Uint16

          • features: Uint16

          • elements: Range of Struct of
            • location: Enum of GATTNamespaceDescriptor as Uint16

            • sig_number: Uint8

            • vendor_number: Uint8

            • sig_models: Array[sig_number] of Struct of
              • model_id: Uint16

            • vendor_models: Array[vendor_number] of Struct of
              • vendor_id: Uint16

              • model_id: Uint16

        • CompositionDataPage.FIRST

        • CompositionDataPage.TWO_HUNDRED_AND_FIFTY_FIFTH

    • ConfigOpcode.CONFIG_DEFAULT_TTL_GET

    • ConfigOpcode.CONFIG_DEFAULT_TTL_SET
      • ttl: Uint8

    • ConfigOpcode.CONFIG_DEFAULT_TTL_STATUS
      • ttl: Uint8

    • ConfigOpcode.CONFIG_FRIEND_GET

    • ConfigOpcode.CONFIG_FRIEND_SET
      • friend: Enum of Friend as Uint8

    • ConfigOpcode.CONFIG_FRIEND_STATUS
      • friend: Enum of Friend as Uint8

    • ConfigOpcode.CONFIG_GATT_PROXY_GET

    • ConfigOpcode.CONFIG_GATT_PROXY_SET
      • GATT_proxy: Enum of GATTProxy as Uint8

    • ConfigOpcode.CONFIG_GATT_PROXY_STATUS
      • GATT_proxy: Enum of GATTProxy as Uint8

    • ConfigOpcode.CONFIG_HEARBEAT_PUBLICATION_GET

    • ConfigOpcode.CONFIG_HEARBEAT_PUBLICATION_SET
      • destination: Uint16

      • count: Uint8

      • period: Uint8

      • ttl: Uint8

      • features: Array[16] of Uint1

      • net_key_index: Uint12

    • ConfigOpcode.CONFIG_HEARBEAT_PUBLICATION_STATUS
      • status: Enum of StatusCode as Uint8

      • destination: Uint16

      • count: Uint8

      • period: Uint8

      • ttl: Uint8

      • features: Array[16] of Uint1

      • net_key_index: Uint12

    • ConfigOpcode.CONFIG_HEARBEAT_SUBSCRIPTION_GET

    • ConfigOpcode.CONFIG_HEARBEAT_SUBSCRIPTION_SET
      • source: Uint16

      • destination: Uint16

      • period_log: Uint8

    • ConfigOpcode.CONFIG_HEARBEAT_SUBSCRIPTION_STATUS
      • status: Enum of StatusCode as Uint8

      • source: Uint16

      • destination: Uint16

      • period_log: Uint8

      • count: Uint8

      • min_hops: Uint8

      • max_hops: Uint8

    • ConfigOpcode.CONFIG_KEY_REFRESH_PHASE_GET
      • net_key_index: Uint12

    • ConfigOpcode.CONFIG_KEY_REFRESH_PHASE_SET
      • net_key_index: Uint12

      • transition: Enum of KeyRefreshTransition as Uint8

    • ConfigOpcode.CONFIG_KEY_REFRESH_PHASE_STATUS
      • status: Enum of StatusCode as Uint8

      • net_key_index: Uint12

      • phase: Enum of KeyRefreshPhase as Uint8

    • ConfigOpcode.CONFIG_LOW_POWER_NODE_POLLTIMEOUT_GET
      • lpn_address: Uint16

    • ConfigOpcode.CONFIG_LOW_POWER_NODE_POLLTIMEOUT_STATUS
      • lpn_address: Uint16

      • poll_timeout: Uint24

    • ConfigOpcode.CONFIG_MODEL_APP_BIND
      • element_address: Uint16

      • app_key_index: Uint12

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_APP_STATUS
      • status: Enum of StatusCode as Uint8

      • element_address: Uint16

      • app_key_index: Uint12

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_APP_UNBIND
      • element_address: Uint16

      • app_key_index: Uint12

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_PUBLICATION_GET
      • element_address: Uint16

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_PUBLICATION_SET
      • element_address: Uint16

      • publish_address: Uint16

      • rfu: Uint3

      • credential_flag: Enum of PublishFriendshipCredentialsFlag as bool

      • app_key_index: Uint12

      • ttl: Uint8

      • publish_period: Struct of
        • step_resolution: Enum of PublishPeriodStepResolution as Uint2

        • number_of_steps: Uint6

      • retransmit: Struct of
        • interval_steps: Uint5

        • count: Uint3

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_PUBLICATION_STATUS
      • status: Enum of StatusCode as Uint8

      • element_address: Uint16

      • publish_address: Uint16

      • rfu: Uint3

      • credential_flag: Enum of PublishFriendshipCredentialsFlag as bool

      • app_key_index: Uint12

      • ttl: Uint8

      • publish_period: Struct of
        • step_resolution: Enum of PublishPeriodStepResolution as Uint2

        • number_of_steps: Uint6

      • retransmit: Struct of
        • interval_steps: Uint5

        • count: Uint3

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_PUBLICATION_VIRTUAL_ADDRESS_SET
      • element_address: Uint16

      • publish_address: bytes[16]

      • RFU: Uint3

      • credential_flag: Enum of PublishFriendshipCredentialsFlag as bool

      • app_key_index: Uint12

      • ttl: Uint8

      • publish_period: Struct of
        • step_resolution: Enum of PublishPeriodStepResolution as Uint2

        • number_of_steps: Uint6

      • retransmit: Struct of
        • interval_steps: Uint5

        • count: Uint3

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_SUBSCRIPTION_ADD
      • element_address: Uint16

      • address: Uint16

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_SUBSCRIPTION_DELETE
      • element_address: Uint16

      • address: Uint16

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_SUBSCRIPTION_DELETE_ALL
      • element_address: Uint16

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_SUBSCRIPTION_OVERWRITE
      • element_address: Uint16

      • address: Uint16

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_SUBSCRIPTION_STATUS
      • status: Enum of StatusCode as Uint8

      • element_address: Uint16

      • address: Uint16

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_SUBSCRIPTION_VIRTUAL_ADDRESS_ADD
      • element_address: Uint16

      • label: bytes[16]

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_SUBSCRIPTION_VIRTUAL_ADDRESS_DELETE
      • element_address: Uint16

      • label: bytes[16]

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_MODEL_SUBSCRIPTION_VIRTUAL_ADDRESS_OVERWRITE
      • element_address: Uint16

      • label: bytes[16]

      • model: Select from
        • vendor: Struct of
          • vendor_id: Uint16

          • model_id: Uint16

        • sig: Struct of
          • model_id: Uint16

    • ConfigOpcode.CONFIG_NETKEY_ADD
      • net_key_index: Uint12

      • net_key: bytes[16]

    • ConfigOpcode.CONFIG_NETKEY_DELETE
      • net_key_index: Uint12

    • ConfigOpcode.CONFIG_NETKEY_GET

    • ConfigOpcode.CONFIG_NETKEY_LIST
      • net_key_indices: Range of Uint12

    • ConfigOpcode.CONFIG_NETKEY_STATUS
      • status: Enum of StatusCode as Uint8

      • net_key_index: Uint12

    • ConfigOpcode.CONFIG_NETKEY_UPDATE
      • net_key_index: Uint12

      • net_key: bytes[16]

    • ConfigOpcode.CONFIG_NETWORK_TRANSMIT_GET

    • ConfigOpcode.CONFIG_NETWORK_TRANSMIT_SET
      • interval_steps: Uint5

      • count: Uint3

    • ConfigOpcode.CONFIG_NETWORK_TRANSMIT_STATUS
      • interval_steps: Uint5

      • count: Uint3

    • ConfigOpcode.CONFIG_NODE_IDENTITY_GET
      • net_key_index: Uint12

    • ConfigOpcode.CONFIG_NODE_IDENTITY_SET
      • net_key_index: Uint12

      • identity: Enum of NodeIdentity as Uint8

    • ConfigOpcode.CONFIG_NODE_IDENTITY_STATUS
      • status: Enum of StatusCode as Uint8

      • net_key_index: Uint12

      • identity: Enum of NodeIdentity as Uint8

    • ConfigOpcode.CONFIG_NODE_RESET

    • ConfigOpcode.CONFIG_NODE_RESET_STATUS

    • ConfigOpcode.CONFIG_RELAY_GET

    • ConfigOpcode.CONFIG_RELAY_SET
      • relay: Enum of Relay as Uint8

      • retransmit: Struct of
        • interval_steps: Uint5

        • count: Uint3

    • ConfigOpcode.CONFIG_RELAY_STATUS
      • relay: Enum of Relay as Uint8

      • retransmit: Struct of
        • interval_steps: Uint5

        • count: Uint3

    • ConfigOpcode.CONFIG_SIG_MODEL_APP_GET
      • element_address: Uint16

      • model: Struct of
        • model_id: Uint16

    • ConfigOpcode.CONFIG_SIG_MODEL_APP_LIST
      • status: Enum of StatusCode as Uint8

      • element_address: Uint16

      • model: Struct of
        • model_id: Uint16

      • app key indices: Range of Uint12

    • ConfigOpcode.CONFIG_SIG_MODEL_SUBSCRIPTION_GET
      • element_address: Uint16

      • model: Struct of
        • model_id: Uint16

    • ConfigOpcode.CONFIG_SIG_MODEL_SUBSCRIPTION_LIST
      • status: Enum of StatusCode as Uint8

      • element_address: Uint16

      • model: Struct of
        • model_id: Uint16

      • addresses: Range of Uint16

    • ConfigOpcode.CONFIG_VENDOR_MODEL_APP_GET
      • element_address: Uint16

      • model: Struct of
        • vendor_id: Uint16

        • model_id: Uint16

    • ConfigOpcode.CONFIG_VENDOR_MODEL_APP_LIST
      • status: Enum of StatusCode as Uint8

      • element_address: Uint16

      • model: Struct of
        • vendor_id: Uint16

        • model_id: Uint16

      • app_key_indices: Range of Uint12

    • ConfigOpcode.CONFIG_VENDOR_MODEL_SUBSCRIPTION_GET
      • element_address: Uint16

      • model: Struct of
        • vendor_id: Uint16

        • model_id: Uint16

    • ConfigOpcode.CONFIG_VENDOR_MODEL_SUBSCRIPTION_LIST
      • status: Enum of StatusCode as Uint8

      • element_address: Uint16

      • model: Struct of
        • vendor_id: Uint16

        • model_id: Uint16

      • addresses: Range of Uint16

Health

class bluetooth_mesh.messages.health.HealthOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.health.HealthMessage = <SwitchStruct <Struct>>
  • opcode: : UNKNOWN

  • params: Switch by opcode
    • HealthOpcode.HEALTH_ATTENTION_GET

    • HealthOpcode.HEALTH_ATTENTION_SET
      • attention: Uint8

    • HealthOpcode.HEALTH_ATTENTION_SET_UNACKNOWLEDGED
      • attention: Uint8

    • HealthOpcode.HEALTH_ATTENTION_STATUS
      • attention: Uint8

    • HealthOpcode.HEALTH_CURRENT_STATUS
      • test_id: Uint8

      • company_id: Uint16

      • fault_array: Range of Uint8

    • HealthOpcode.HEALTH_FAULT_CLEAR
      • company_id: Uint16

    • HealthOpcode.HEALTH_FAULT_CLEAR_UNACKNOWLEDGED
      • company_id: Uint16

    • HealthOpcode.HEALTH_FAULT_GET
      • company_id: Uint16

    • HealthOpcode.HEALTH_FAULT_STATUS
      • test_id: Uint8

      • company_id: Uint16

      • fault_array: Range of Uint8

    • HealthOpcode.HEALTH_FAULT_TEST
      • test_id: Uint8

      • company_id: Uint16

    • HealthOpcode.HEALTH_FAULT_TEST_UNACKNOWLEDGED
      • test_id: Uint8

      • company_id: Uint16

    • HealthOpcode.HEALTH_PERIOD_GET

    • HealthOpcode.HEALTH_PERIOD_SET
      • fast_period_divisor: Uint8

    • HealthOpcode.HEALTH_PERIOD_SET_UNACKNOWLEDGED
      • fast_period_divisor: Uint8

    • HealthOpcode.HEALTH_PERIOD_STATUS
      • fast_period_divisor: Uint8

Debug

class bluetooth_mesh.messages.silvair.debug.DebugOpcode(value)[source]

An enumeration.

class bluetooth_mesh.messages.silvair.debug.DebugSubOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.silvair.debug.DebugMessage = <SwitchStruct <Struct>>
  • opcode: : UNKNOWN

  • params: Switch by opcode
    • DebugOpcode.SILVAIR_DEBUG
      • subopcode: Enum of DebugSubOpcode as Uint8

      • payload: Switch by subopcode
        • DebugSubOpcode.RSSI_THRESHOLD_SET
          • rssi_threshold: Uint8

        • DebugSubOpcode.RSSI_THRESHOLD_STATUS
          • rssi_threshold: Uint8

        • DebugSubOpcode.RADIO_TEST
          • packet_counter: Uint8

        • DebugSubOpcode.TIMESLOT_TX_POWER_SET
          • tx_power: Uint8

        • DebugSubOpcode.TIMESLOT_TX_POWER_STATUS
          • tx_power: Uint8

        • DebugSubOpcode.SOFTDEVICE_TX_POWER_SET
          • tx_power: Uint8

        • DebugSubOpcode.SOFTDEVICE_TX_POWER_STATUS
          • tx_power: Uint8

        • DebugSubOpcode.UPTIME_STATUS
          • uptime: Uint32

        • DebugSubOpcode.LAST_SW_FAULT_STATUS
          • time: Uint32

          • fault: bytes

        • DebugSubOpcode.SYSTEM_STATS_STATUS
          • stats: Range of Struct of
            • name: bytes

            • high_water_mark: Uint16

        • DebugSubOpcode.LAST_MALLOC_FAULT_STATUS
          • time: Uint32

          • fault: bytes

        • DebugSubOpcode.LAST_FDS_FAULT_STATUS
          • time: Uint32

          • fault: bytes

        • DebugSubOpcode.BYTES_BEFORE_GARBAGE_COLLECTOR_STATUS
          • bytes_left: Uint16

        • DebugSubOpcode.PROVISIONED_APP_VERSION_STATUS
          • version: Uint16

        • DebugSubOpcode.FULL_FIRMWARE_VERSION_STATUS
          • version: bytes

        • DebugSubOpcode.IV_INDEX_STATUS
          • ivindex: Uint32

        • DebugSubOpcode.GARBAGE_COLLECTOR_COUNTER_STATUS
          • counter: Uint16

        • DebugSubOpcode.ARAP_LIST_SIZE_STATUS
          • new: Struct of
            • capacity: Uint16

            • size: Uint16

          • old: Struct of
            • capacity: Uint8

            • size: Uint8

        • DebugSubOpcode.ARAP_LIST_CONTENT_GET
          • page: Uint8

        • DebugSubOpcode.ARAP_LIST_CONTENT_STATUS
          • current_page: Uint8

          • last_page: Uint8

          • nodes: Range of Struct of
            • sequence: Uint24

            • ivi: Uint1

            • address: Uint15

Network Diagnostic

Server

class bluetooth_mesh.messages.silvair.network_diagnostic_server.NetworkDiagnosticServerOpcode(value)[source]

An enumeration.

class bluetooth_mesh.messages.silvair.network_diagnostic_server.NetworkDiagnosticServerSubOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.silvair.network_diagnostic_server.NetworkDiagnosticServerMessage = <SwitchStruct <Struct>>
  • opcode: : UNKNOWN

  • params: Switch by opcode
    • NetworkDiagnosticServerOpcode.SILVAIR_NDS
      • subopcode: Enum of NetworkDiagnosticServerSubOpcode as Uint8

      • payload: Switch by subopcode
        • NetworkDiagnosticServerSubOpcode.SUBSCRIPTION_SET
          • destination: Uint16

          • period: Uint16

        • NetworkDiagnosticServerSubOpcode.SUBSCRIPTION_SET_UNACK
          • destination: Uint16

          • period: Uint16

        • NetworkDiagnosticServerSubOpcode.SUBSCRIPTION_STATUS
          • destination: Uint16

          • period: Uint16

          • max_record_count: Const 32

          • record: Range of Struct of
            • source: Uint16

            • count: Uint16

            • min_hops: Uint8

            • max_hops: Uint8

Setup Server

class bluetooth_mesh.messages.silvair.network_diagnostic_server.NetworkDiagnosticSetupServerOpcode(value)[source]

An enumeration.

class bluetooth_mesh.messages.silvair.network_diagnostic_server.NetworkDiagnosticSetupServerSubOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.silvair.network_diagnostic_server.NetworkDiagnosticSetupServerMessage = <SwitchStruct <Struct>>
  • opcode: : UNKNOWN

  • params: Switch by opcode
    • NetworkDiagnosticSetupServerOpcode.SILVAIR_NDS_SETUP
      • subopcode: Enum of NetworkDiagnosticSetupServerSubOpcode as Uint8

      • payload: Switch by subopcode
        • NetworkDiagnosticSetupServerSubOpcode.PUBLICATION_SET
          • : UNKNOWN

          • : UNKNOWN

        • NetworkDiagnosticSetupServerSubOpcode.PUBLICATION_STATUS
          • : UNKNOWN

          • : UNKNOWN