bluetooth_mesh.messages

bluetooth_mesh.messages.AccessMessage = <Select>

  • ConfigMessage

  • DebugMessage

  • GatewayConfigMessage

  • GenericMessage

  • HealthMessage

  • Message

  • NetworkDiagnosticServerMessage

  • SceneMessage

  • SensorMessage

  • SensorSetupMessage

Config

class bluetooth_mesh.messages.config.ConfigOpcode[source]

An enumeration.

bluetooth_mesh.messages.config.ConfigMessage = <Struct>
  • opcode: Enum of ConfigOpcode as Select from

    • Uint8

    • Uint16

    • Uint24

  • params: Switch by opcode
    • ConfigOpcode.APPKEY_ADD

      • app_key_index: Uint12

      • net_key_index: Uint12

      • app_key: bytes[16]

    • ConfigOpcode.APPKEY_DELETE

      • app_key_index: Uint12

      • net_key_index: Uint12

    • ConfigOpcode.APPKEY_GET

      • net_key_index: Uint12

    • ConfigOpcode.APPKEY_LIST

      • status: Enum of StatusCode as Uint8

      • net_key_index: Uint12

      • app_key_indices: Range of Uint12

    • ConfigOpcode.APPKEY_STATUS

      • status: Enum of StatusCode as Uint8

      • app_key_index: Uint12

      • net_key_index: Uint12

    • ConfigOpcode.APPKEY_UPDATE

      • app_key_index: Uint12

      • net_key_index: Uint12

      • app_key: bytes[16]

    • ConfigOpcode.BEACON_GET

    • ConfigOpcode.BEACON_SET

      • beacon: Enum of SecureNetworkBeacon as Uint8

    • ConfigOpcode.BEACON_STATUS

      • beacon: Enum of SecureNetworkBeacon as Uint8

    • ConfigOpcode.COMPOSITION_DATA_GET

      • page: Uint8

    • ConfigOpcode.COMPOSITION_DATA_STATUS

      • page: Uint8

      • data: Switch by page
        • 0

          • 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

    • ConfigOpcode.DEFAULT_TTL_GET

    • ConfigOpcode.DEFAULT_TTL_SET

      • TTL: Uint8

    • ConfigOpcode.DEFAULT_TTL_STATUS

      • TTL: Uint8

    • ConfigOpcode.FRIEND_GET

    • ConfigOpcode.FRIEND_SET

      • friend: Enum of Friend as Uint8

    • ConfigOpcode.FRIEND_STATUS

      • friend: Enum of Friend as Uint8

    • ConfigOpcode.GATT_PROXY_GET

    • ConfigOpcode.GATT_PROXY_SET

      • GATT_proxy: Enum of GATTProxy as Uint8

    • ConfigOpcode.GATT_PROXY_STATUS

      • GATT_proxy: Enum of GATTProxy as Uint8

    • ConfigOpcode.HEARBEAT_PUBLICATION_GET

    • ConfigOpcode.HEARBEAT_PUBLICATION_SET

      • destination: Uint16

      • count: Uint8

      • period: Uint8

      • TTL: Uint8

      • features: Array[16] of Uint1

      • net_key_index: Uint12

    • ConfigOpcode.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.HEARBEAT_SUBSCRIPTION_GET

    • ConfigOpcode.HEARBEAT_SUBSCRIPTION_SET

      • source: Uint16

      • destination: Uint16

      • period_log: Uint8

    • ConfigOpcode.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.KEY_REFRESH_PHASE_GET

      • net_key_index: Uint12

    • ConfigOpcode.KEY_REFRESH_PHASE_SET

      • net_key_index: Uint12

      • transition: Enum of KeyRefreshTransition as Uint8

    • ConfigOpcode.KEY_REFRESH_PHASE_STATUS

      • status: Enum of StatusCode as Uint8

      • net_key_index: Uint12

      • phase: Enum of KeyRefreshPhase as Uint8

    • ConfigOpcode.LOW_POWER_NODE_POLLTIMEOUT_GET

      • lpn_address: Uint16

    • ConfigOpcode.LOW_POWER_NODE_POLLTIMEOUT_STATUS

      • lpn_address: Uint16

      • poll_timeout: Uint24

    • ConfigOpcode.MODEL_APP_BIND

      • element_address: Uint16

      • app_key_index: Uint12

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.MODEL_APP_STATUS

      • status: Enum of StatusCode as Uint8

      • element_address: Uint16

      • app_key_index: Uint12

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.MODEL_APP_UNBIND

      • element_address: Uint16

      • app_key_index: Uint12

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.MODEL_PUBLICATION_GET

      • element_address: Uint16

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.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
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.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
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.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
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.MODEL_SUBSCRIPTION_ADD

      • element_address: Uint16

      • address: Uint16

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.MODEL_SUBSCRIPTION_DELETE

      • element_address: Uint16

      • address: Uint16

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.MODEL_SUBSCRIPTION_DELETE_ALL

      • element_address: Uint16

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.MODEL_SUBSCRIPTION_OVERWRITE

      • element_address: Uint16

      • address: Uint16

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.MODEL_SUBSCRIPTION_STATUS

      • status: Enum of StatusCode as Uint8

      • element_address: Uint16

      • address: Uint16

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.MODEL_SUBSCRIPTION_VIRTUAL_ADDRESS_ADD

      • element_address: Uint16

      • label: bytes[16]

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.MODEL_SUBSCRIPTION_VIRTUAL_ADDRESS_DELETE

      • element_address: Uint16

      • label: bytes[16]

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.MODEL_SUBSCRIPTION_VIRTUAL_ADDRESS_OVERWRITE

      • element_address: Uint16

      • label: bytes[16]

      • model: Select from
        • Struct of

          • vendor_id: Uint16

          • model_id: Uint16

        • Struct of

          • model_id: Uint16

    • ConfigOpcode.NETKEY_ADD

      • net_key_index: Uint12

      • net_key: bytes[16]

    • ConfigOpcode.NETKEY_DELETE

      • net_key_index: Uint12

    • ConfigOpcode.NETKEY_GET

    • ConfigOpcode.NETKEY_LIST

      • net_key_indices: Range of Uint12

    • ConfigOpcode.NETKEY_STATUS

      • status: Enum of StatusCode as Uint8

      • net_key_index: Uint12

    • ConfigOpcode.NETKEY_UPDATE

      • net_key_index: Uint12

      • net_key: bytes[16]

    • ConfigOpcode.NETWORK_TRANSMIT_GET

    • ConfigOpcode.NETWORK_TRANSMIT_SET

      • interval_steps: Uint5

      • count: Uint3

    • ConfigOpcode.NETWORK_TRANSMIT_STATUS

      • interval_steps: Uint5

      • count: Uint3

    • ConfigOpcode.NODE_IDENTITY_GET

      • net_key_index: Uint12

    • ConfigOpcode.NODE_IDENTITY_SET

      • net_key_index: Uint12

      • identity: Enum of NodeIdentity as Uint8

    • ConfigOpcode.NODE_IDENTITY_STATUS

      • status: Enum of StatusCode as Uint8

      • net_key_index: Uint12

      • identity: Enum of NodeIdentity as Uint8

    • ConfigOpcode.NODE_RESET

    • ConfigOpcode.NODE_RESET_STATUS

    • ConfigOpcode.RELAY_GET

    • ConfigOpcode.RELAY_SET

      • relay: Enum of Relay as Uint8

      • retransmit: Struct of

        • interval_steps: Uint5

        • count: Uint3

    • ConfigOpcode.RELAY_STATUS

      • relay: Enum of Relay as Uint8

      • retransmit: Struct of

        • interval_steps: Uint5

        • count: Uint3

    • ConfigOpcode.SIG_MODEL_APP_GET

      • element_address: Uint16

      • model: Struct of

        • model_id: Uint16

    • ConfigOpcode.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.SIG_MODEL_SUBSCRIPTION_GET

      • element_address: Uint16

      • model: Struct of

        • model_id: Uint16

    • ConfigOpcode.SIG_MODEL_SUBSCRIPTION_LIST

      • status: Enum of StatusCode as Uint8

      • element_address: Uint16

      • model: Struct of

        • model_id: Uint16

      • addresses: Range of Uint16

    • ConfigOpcode.VENDOR_MODEL_APP_GET

      • element_address: Uint16

      • model: Struct of

        • vendor_id: Uint16

        • model_id: Uint16

    • ConfigOpcode.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.VENDOR_MODEL_SUBSCRIPTION_GET

      • element_address: Uint16

      • model: Struct of

        • vendor_id: Uint16

        • model_id: Uint16

    • ConfigOpcode.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[source]

An enumeration.

bluetooth_mesh.messages.health.HealthMessage = <Struct>
  • opcode: Enum of HealthOpcode as Select from

    • Uint8

    • Uint16

    • Uint24

  • params: Switch by opcode

    • HealthOpcode.ATTENTION_GET

    • HealthOpcode.ATTENTION_SET

      • attention: Uint8

    • HealthOpcode.ATTENTION_SET_UNACKNOWLEDGED

      • attention: Uint8

    • HealthOpcode.ATTENTION_STATUS

      • attention: Uint8

    • HealthOpcode.CURRENT_STATUS

      • test_id: Uint8

      • company_id: Uint16

      • fault_array: Range of Uint8

    • HealthOpcode.FAULT_CLEAR

      • company_id: Uint16

    • HealthOpcode.FAULT_CLEAR_UNACKNOWLEDGED

      • company_id: Uint16

    • HealthOpcode.FAULT_GET

      • company_id: Uint16

    • HealthOpcode.FAULT_STATUS

      • test_id: Uint8

      • company_id: Uint16

      • fault_array: Range of Uint8

    • HealthOpcode.FAULT_TEST

      • test_id: Uint8

      • company_id: Uint16

    • HealthOpcode.FAULT_TEST_UNACKNOWLEDGED

      • test_id: Uint8

      • company_id: Uint16

    • HealthOpcode.PERIOD_GET

    • HealthOpcode.PERIOD_SET

      • fast_period_divisor: Uint8

    • HealthOpcode.PERIOD_SET_UNACKNOWLEDGED

      • fast_period_divisor: Uint8

    • HealthOpcode.PERIOD_STATUS

      • fast_period_divisor: Uint8

Debug

class bluetooth_mesh.messages.silvair.debug.DebugOpcode[source]

An enumeration.

class bluetooth_mesh.messages.silvair.debug.DebugSubOpcode[source]

An enumeration.

bluetooth_mesh.messages.silvair.debug.DebugMessage = <Struct>

  • opcode: Const DebugOpcode.OPCODE

  • params: Struct of

    • subopcode: Enum of DebugSubOpcode as Uint8

    • data: 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
        • Struct of

          • capacity: Uint16

          • size: Uint16

        • 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[source]

An enumeration.

class bluetooth_mesh.messages.silvair.network_diagnostic_server.NetworkDiagnosticServerSubOpcode[source]

An enumeration.

bluetooth_mesh.messages.silvair.network_diagnostic_server.NetworkDiagnosticServerMessage = <Struct>

  • opcode: Const NetworkDiagnosticServerOpcode.OPCODE

  • params: Struct of

    • 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[source]

An enumeration.

class bluetooth_mesh.messages.silvair.network_diagnostic_server.NetworkDiagnosticSetupServerSubOpcode[source]

An enumeration.

bluetooth_mesh.messages.silvair.network_diagnostic_server.NetworkDiagnosticSetupServerMessage = <Struct>

  • opcode: Const NetworkDiagnosticSetupServerOpcode.OPCODE

  • params: Struct of

    • subopcode: Enum of NetworkDiagnosticSetupServerSubOpcode as Uint8

    • payload: Switch by subopcode
      • NetworkDiagnosticSetupServerSubOpcode.PUBLICATION_SET

        • destination: Uint16

        • count: Uint16

        • period: Struct of

          • resolution: Uint2

          • steps: Uint6

        • ttl: Uint8

        • net_key_index: Uint16

        • features: Select from

          • Uint16

          • None

      • NetworkDiagnosticSetupServerSubOpcode.PUBLICATION_STATUS

        • destination: Uint16

        • count: Uint16

        • period: Struct of

          • resolution: Uint2

          • steps: Uint6

        • ttl: Uint8

        • net_key_index: Uint16

        • features: Select from

          • Uint16

          • None