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: Uint32

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

            • number_s: Uint8

            • number_v: Uint8

            • sig_models: Array[number_s] of Struct of

              • extended_items_count: Uint6

              • format: Enum of ExtendedModelsItemFormat as Uint1

              • corresponding_present: Uint1

              • corresponding_id: : UNKNOWN

              • extended_models_items: Switch by format
                • ExtendedModelsItemFormat.SHORT

                  • model_item_index: Uint5

                  • element_offset: Int3

                • ExtendedModelsItemFormat.LONG

                  • model_item_index: Uint8

                  • element_offset: Int8

            • vendor_models: Array[number_v] of Struct of

              • extended_items_count: Uint6

              • format: Enum of ExtendedModelsItemFormat as Uint1

              • corresponding_present: Uint1

              • corresponding_id: : UNKNOWN

              • extended_models_items: Switch by format
                • ExtendedModelsItemFormat.SHORT

                  • model_item_index: Uint5

                  • element_offset: Int3

                • ExtendedModelsItemFormat.LONG

                  • model_item_index: Uint8

                  • element_offset: Int8

        • CompositionDataPage.SECOND
          • record_list: Range of Struct of

            • mesh_profile_identifier: Uint16

            • version: Struct of

              • version_x: Uint8

              • version_y: Uint8

              • version_z: Uint8

            • num_element_offsets: Uint8

            • element_offset_list: Array[num_element_offsets] of Uint8

            • additional_data_len: Uint16

            • additional_data: Array[additional_data_len] of Uint8

        • 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_POLL_TIMEOUT_GET

      • lpn_address: Uint16

    • ConfigOpcode.CONFIG_LOW_POWER_NODE_POLL_TIMEOUT_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: Uint32

  • 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

Generic Level

class bluetooth_mesh.messages.generic.level.GenericLevelOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.generic.level.GenericLevelMessage = <SwitchStruct <Struct>>

  • opcode: Uint32

  • params: Switch by opcode

    • GenericLevelOpcode.GENERIC_LEVEL_GET

    • GenericLevelOpcode.GENERIC_LEVEL_SET
      • optional: Struct of

        • level: Int16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • level: Int16

        • tid: Uint8

    • GenericLevelOpcode.GENERIC_LEVEL_SET_UNACKNOWLEDGED
      • optional: Struct of

        • level: Int16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • level: Int16

        • tid: Uint8

    • GenericLevelOpcode.GENERIC_LEVEL_STATUS
      • optional: Struct of

        • present_level: Int16

        • target_level: Int16

        • remaining_time: Struct of

          • resolution: Uint2

          • steps: Uint6

      • minimal: Struct of

        • present_level: Int16

    • GenericLevelOpcode.GENERIC_DELTA_SET
      • optional: Struct of

        • delta_level: Int32

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • delta_level: Int32

        • tid: Uint8

    • GenericLevelOpcode.GENERIC_DELTA_SET_UNACKNOWLEDGED
      • optional: Struct of

        • delta_level: Int32

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • delta_level: Int32

        • tid: Uint8

    • GenericLevelOpcode.GENERIC_MOVE_SET
      • optional: Struct of

        • delta_level: Int16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • delta_level: Int16

        • tid: Uint8

    • GenericLevelOpcode.GENERIC_MOVE_SET_UNACKNOWLEDGED
      • optional: Struct of

        • delta_level: Int16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • delta_level: Int16

        • tid: Uint8

Generic OnOff

class bluetooth_mesh.messages.generic.onoff.GenericOnOffOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.generic.onoff.GenericOnOffMessage = <SwitchStruct <Struct>>

  • opcode: Uint32

  • params: Switch by opcode

    • GenericOnOffOpcode.GENERIC_ONOFF_GET

    • GenericOnOffOpcode.GENERIC_ONOFF_SET
      • optional: Struct of

        • onoff: Uint8

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • onoff: Uint8

        • tid: Uint8

    • GenericOnOffOpcode.GENERIC_ONOFF_SET_UNACKNOWLEDGED
      • optional: Struct of

        • onoff: Uint8

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • onoff: Uint8

        • tid: Uint8

    • GenericOnOffOpcode.GENERIC_ONOFF_STATUS
      • optional: Struct of

        • present_onoff: Uint8

        • target_onoff: Uint8

        • remaining_time: Struct of

          • resolution: Uint2

          • steps: Uint6

      • minimal: Struct of

        • present_onoff: Uint8

Generic Battery

class bluetooth_mesh.messages.generic.battery.GenericBatteryOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.generic.battery.GenericBatteryMessage = <SwitchStruct <Struct>>

  • opcode: Uint32

  • params: Switch by opcode

    • GenericBatteryOpcode.GENERIC_BATTERY_GET

    • GenericBatteryOpcode.GENERIC_BATTERY_STATUS

      • battery_level: Uint8

      • time_to_discharge: Uint24

      • time_to_charge: Uint24

      • flags: Struct of

        • battery_serviceability_flags: Enum of GenericBatteryFlagsServiceability as Uint2

        • battery_charging_flags: Enum of GenericBatteryFlagsCharging as Uint2

        • battery_indicator_flags: Enum of GenericBatteryFlagsIndicator as Uint2

        • battery_presence_flags: Enum of GenericBatteryFlagsPresence as Uint2

Light Lightness

Server

class bluetooth_mesh.messages.generic.light.lightness.LightLightnessOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.generic.light.lightness.LightLightnessMessage = <SwitchStruct <Struct>>

  • opcode: Uint32

  • params: Switch by opcode

    • LightLightnessOpcode.LIGHT_LIGHTNESS_GET

    • LightLightnessOpcode.LIGHT_LIGHTNESS_SET
      • optional: Struct of

        • lightness: Uint16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • lightness: Uint16

        • tid: Uint8

    • LightLightnessOpcode.LIGHT_LIGHTNESS_SET_UNACKNOWLEDGED
      • optional: Struct of

        • lightness: Uint16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • lightness: Uint16

        • tid: Uint8

    • LightLightnessOpcode.LIGHT_LIGHTNESS_STATUS
      • optional: Struct of

        • present_lightness: Uint16

        • target_lightness: Uint16

        • remaining_time: Struct of

          • resolution: Uint2

          • steps: Uint6

      • minimal: Struct of

        • present_lightness: Uint16

    • LightLightnessOpcode.LIGHT_LIGHTNESS_LINEAR_GET

    • LightLightnessOpcode.LIGHT_LIGHTNESS_LINEAR_SET
      • optional: Struct of

        • lightness: Uint16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • lightness: Uint16

        • tid: Uint8

    • LightLightnessOpcode.LIGHT_LIGHTNESS_LINEAR_SET_UNACKNOWLEDGED
      • optional: Struct of

        • lightness: Uint16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • lightness: Uint16

        • tid: Uint8

    • LightLightnessOpcode.LIGHT_LIGHTNESS_LINEAR_STATUS
      • optional: Struct of

        • present_lightness: Uint16

        • target_lightness: Uint16

        • remaining_time: Struct of

          • resolution: Uint2

          • steps: Uint6

      • minimal: Struct of

        • present_lightness: Uint16

    • LightLightnessOpcode.LIGHT_LIGHTNESS_LAST_GET

    • LightLightnessOpcode.LIGHT_LIGHTNESS_LAST_STATUS

      • lightness: Uint16

    • LightLightnessOpcode.LIGHT_LIGHTNESS_DEFAULT_GET

    • LightLightnessOpcode.LIGHT_LIGHTNESS_DEFAULT_STATUS

      • lightness: Uint16

    • LightLightnessOpcode.LIGHT_LIGHTNESS_RANGE_GET

    • LightLightnessOpcode.LIGHT_LIGHTNESS_RANGE_STATUS

      • status: Enum of StatusCode as Uint8

      • range_min: Uint16

      • range_max: Uint16

Setup Server

class bluetooth_mesh.messages.generic.light.lightness.LightLightnessSetupOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.generic.light.lightness.LightLightnessSetupMessage = <SwitchStruct <Struct>>

  • opcode: Uint32

  • params: Switch by opcode
    • LightLightnessSetupOpcode.LIGHT_LIGHTNESS_SETUP_DEFAULT_SET

      • lightness: Uint16

    • LightLightnessSetupOpcode.LIGHT_LIGHTNESS_SETUP_DEFAULT_SET_UNACKNOWLEDGED

      • lightness: Uint16

    • LightLightnessSetupOpcode.LIGHT_LIGHTNESS_SETUP_RANGE_SET

      • range_min: Uint16

      • range_max: Uint16

    • LightLightnessSetupOpcode.LIGHT_LIGHTNESS_SETUP_RANGE_SET_UNACKNOWLEDGED

      • range_min: Uint16

      • range_max: Uint16

Light CTL

Server

class bluetooth_mesh.messages.generic.light.ctl.LightCTLOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.generic.light.ctl.LightCTLMessage = <SwitchStruct <Struct>>

  • opcode: Uint32

  • params: Switch by opcode

    • LightCTLOpcode.LIGHT_CTL_GET

    • LightCTLOpcode.LIGHT_CTL_SET
      • optional: Struct of

        • ctl_lightness: Uint16

        • ctl_temperature: Uint16

        • ctl_delta_uv: Uint16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • ctl_lightness: Uint16

        • ctl_temperature: Uint16

        • ctl_delta_uv: Uint16

        • tid: Uint8

    • LightCTLOpcode.LIGHT_CTL_SET_UNACKNOWLEDGED
      • optional: Struct of

        • ctl_lightness: Uint16

        • ctl_temperature: Uint16

        • ctl_delta_uv: Uint16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • ctl_lightness: Uint16

        • ctl_temperature: Uint16

        • ctl_delta_uv: Uint16

        • tid: Uint8

    • LightCTLOpcode.LIGHT_CTL_STATUS
      • optional: Struct of

        • present_ctl_lightness: Uint16

        • present_ctl_temperature: Uint16

        • target_ctl_lightness: Uint16

        • target_ctl_temperature: Uint16

        • remaining_time: Struct of

          • resolution: Uint2

          • steps: Uint6

      • minimal: Struct of

        • present_ctl_lightness: Uint16

        • present_ctl_temperature: Uint16

    • LightCTLOpcode.LIGHT_CTL_TEMPERATURE_GET

    • LightCTLOpcode.LIGHT_CTL_TEMPERATURE_RANGE_GET

    • LightCTLOpcode.LIGHT_CTL_TEMPERATURE_RANGE_STATUS

      • status: Enum of StatusCode as Uint8

      • range_min: Uint16

      • range_max: Uint16

    • LightCTLOpcode.LIGHT_CTL_TEMPERATURE_SET
      • optional: Struct of

        • ctl_temperature: Uint16

        • ctl_delta_uv: Uint16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • ctl_temperature: Uint16

        • ctl_delta_uv: Uint16

        • tid: Uint8

    • LightCTLOpcode.LIGHT_CTL_TEMPERATURE_SET_UNACKNOWLEDGED
      • optional: Struct of

        • ctl_temperature: Uint16

        • ctl_delta_uv: Uint16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • ctl_temperature: Uint16

        • ctl_delta_uv: Uint16

        • tid: Uint8

    • LightCTLOpcode.LIGHT_CTL_TEMPERATURE_STATUS
      • optional: Struct of

        • present_ctl_temperature: Uint16

        • present_ctl_delta_uv: Uint16

        • target_ctl_temperature: Uint16

        • target_ctl_delta_uv: Uint16

        • remaining_time: Struct of

          • resolution: Uint2

          • steps: Uint6

      • minimal: Struct of

        • present_ctl_temperature: Uint16

        • present_ctl_delta_uv: Uint16

    • LightCTLOpcode.LIGHT_CTL_TEMPERATURE_DEFAULT_GET

    • LightCTLOpcode.LIGHT_CTL_TEMPERATURE_DEFAULT_STATUS

      • ctl_lightness: Uint16

      • ctl_temperature: Uint16

      • ctl_delta_uv: Uint16

Setup Server

class bluetooth_mesh.messages.generic.light.ctl.LightCTLSetupOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.generic.light.ctl.LightCTLSetupMessage = <SwitchStruct <Struct>>

  • opcode: Uint32

  • params: Switch by opcode
    • LightCTLSetupOpcode.LIGHT_CTL_SETUP_TEMPERATURE_DEFAULT_SET

      • ctl_lightness: Uint16

      • ctl_temperature: Uint16

      • ctl_delta_uv: Uint16

    • LightCTLSetupOpcode.LIGHT_CTL_SETUP_TEMPERATURE_DEFAULT_SET_UNACKNOWLEDGED

      • ctl_lightness: Uint16

      • ctl_temperature: Uint16

      • ctl_delta_uv: Uint16

    • LightCTLSetupOpcode.LIGHT_CTL_SETUP_TEMPERATURE_RANGE_SET

      • range_min: Uint16

      • range_max: Uint16

    • LightCTLSetupOpcode.LIGHT_CTL_SETUP_TEMPERATURE_RANGE_SET_UNACKNOWLEDGED

      • range_min: Uint16

      • range_max: Uint16

Scene Server

class bluetooth_mesh.messages.scene.SceneOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.scene.SceneMessage = <SwitchStruct <Struct>>

  • opcode: Uint32

  • params: Switch by opcode

    • SceneOpcode.SCENE_GET

    • SceneOpcode.SCENE_RECALL
      • optional: Struct of

        • scene_number: Uint16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • scene_number: Uint16

        • tid: Uint8

    • SceneOpcode.SCENE_RECALL_UNACKNOWLEDGED
      • optional: Struct of

        • scene_number: Uint16

        • tid: Uint8

        • transition_time: Struct of

          • resolution: Uint2

          • steps: Uint6

        • delay: Uint8

      • minimal: Struct of

        • scene_number: Uint16

        • tid: Uint8

    • SceneOpcode.SCENE_STATUS
      • optional: Struct of

        • status_code: Enum of SceneStatusCode as Uint8

        • current_scene: Uint16

        • target_scene: Uint16

        • remaining_time: Struct of

          • resolution: Uint2

          • steps: Uint6

      • minimal: Struct of

        • status_code: Enum of SceneStatusCode as Uint8

        • current_scene: Uint16

    • SceneOpcode.SCENE_REGISTER_GET

    • SceneOpcode.SCENE_REGISTER_STATUS

      • status_code: Enum of SceneStatusCode as Uint8

      • current_scene: Uint16

      • scenes: Range of Uint16

    • SceneOpcode.SCENE_STORE

      • scene_number: Uint16

    • SceneOpcode.SCENE_STORE_UNACKNOWLEDGED

      • scene_number: Uint16

    • SceneOpcode.SCENE_DELETE

      • scene_number: Uint16

    • SceneOpcode.SCENE_DELETE_UNACKNOWLEDGED

      • scene_number: Uint16

Sensor

Server

class bluetooth_mesh.messages.sensor.SensorOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.sensor.SensorMessage = <SwitchStruct <Struct>>

  • opcode: Uint32

  • params: Switch by opcode
    • SensorOpcode.SENSOR_DESCRIPTOR_GET
      • optional: Struct of
        • property_id: Select from

          • Enum of PropertyID as Uint16

          • Uint16

      • minimal: Struct of

    • SensorOpcode.SENSOR_DESCRIPTOR_STATUS
      • optional: Struct of
        • sensor_property_id: Select from

          • Enum of PropertyID as Uint16

          • Uint16

        • sensor_positive_tolerance: Uint12

        • sensor_negative_tolerance: Uint12

        • sensor_sampling_funcion: Uint8

        • sensor_measurement_period: Uint8

        • sensor_update_interval: Uint8

      • minimal: Struct of
        • sensor_property_id: Select from

          • Enum of PropertyID as Uint16

          • Uint16

    • SensorOpcode.SENSOR_GET
      • optional: Struct of
        • property_id: Select from

          • Enum of PropertyID as Uint16

          • Uint16

      • minimal: Struct of

    • SensorOpcode.SENSOR_STATUS

Setup Server

class bluetooth_mesh.messages.sensor.SensorSetupOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.sensor.SensorSetupMessage = <SwitchStruct <Struct>>

  • opcode: Uint32

  • params: Switch by opcode
    • SensorSetupOpcode.SENSOR_CADENCE_GET
      • property_id: Select from

        • Enum of PropertyID as Uint16

        • Uint16

    • SensorSetupOpcode.SENSOR_SETTINGS_GET
      • sensor_property_id: Select from

        • Enum of PropertyID as Uint16

        • Uint16

    • SensorSetupOpcode.SENSOR_SETTINGS_STATUS
      • sensor_property_id: Select from

        • Enum of PropertyID as Uint16

        • Uint16

      • sensor_setting_property_ids: Range of Select from

        • Enum of PropertyID as Uint16

        • Uint16

    • SensorSetupOpcode.SENSOR_SETTING_GET
      • sensor_property_id: Select from

        • Enum of PropertyID as Uint16

        • Uint16

      • sensor_setting_property_id: Select from

        • Enum of PropertyID as Uint16

        • Uint16

    • SensorSetupOpcode.SENSOR_SETTING_SET

    • SensorSetupOpcode.SENSOR_SETTING_SET_UNACKNOWLEDGED

    • SensorSetupOpcode.SENSOR_SETTING_STATUS

Time

class bluetooth_mesh.messages.time.TimeOpcode(value)[source]

An enumeration.

bluetooth_mesh.messages.time.TimeMessage = <SwitchStruct <Struct>>

  • opcode: Uint32

  • params: Switch by opcode

    • TimeOpcode.TIME_GET

    • TimeOpcode.TIME_SET
      • optional: Struct of

        • tai_seconds: Uint40

        • subsecond: Uint8

        • uncertainty: Uint8

        • tai_utc_delta: Uint15

        • time_authority: bool

        • time_zone_offset: Uint8

      • minimal: Struct of

        • tai_seconds: Uint40

    • TimeOpcode.TIME_STATUS
      • optional: Struct of

        • tai_seconds: Uint40

        • subsecond: Uint8

        • uncertainty: Uint8

        • tai_utc_delta: Uint15

        • time_authority: bool

        • time_zone_offset: Uint8

      • minimal: Struct of

        • tai_seconds: Uint40

    • TimeOpcode.TIME_ZONE_GET

    • TimeOpcode.TIME_ZONE_SET

      • time_zone_offset_new: Uint8

      • tai_of_zone_change: Uint40

    • TimeOpcode.TIME_ZONE_STATUS

      • time_zone_offset_current: Uint8

      • time_zone_offset_new: Uint8

      • tai_of_zone_change: Uint40

    • TimeOpcode.TAI_UTC_DELTA_GET

    • TimeOpcode.TAI_UTC_DELTA_SET

      • tai_utc_delta_new: Uint15

      • tai_of_delta_change: Uint40

    • TimeOpcode.TAI_UTC_DELTA_STATUS

      • tai_utc_delta_current: Uint15

      • tai_utc_delta_new: Uint15

      • tai_of_delta_change: Uint40

    • TimeOpcode.TIME_ROLE_GET

    • TimeOpcode.TIME_ROLE_SET

      • time_role: Enum of TimeRole as Uint8

    • TimeOpcode.TIME_ROLE_STATUS

      • time_role: Enum of TimeRole as Uint8

Silvair 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: Uint32

  • params: Switch by opcode
    • DebugOpcode.SILVAIR_DEBUG

      • subopcode: Enum of DebugSubOpcode as Uint8

      • payload: Switch by subopcode

        • DebugSubOpcode.RSSI_THRESHOLD_GET

        • DebugSubOpcode.RSSI_THRESHOLD_SET

          • rssi_threshold: Uint8

        • DebugSubOpcode.RSSI_THRESHOLD_STATUS

          • rssi_threshold: Uint8

        • DebugSubOpcode.RADIO_TEST

          • packet_counter: Uint8

        • DebugSubOpcode.UPTIME_GET

        • DebugSubOpcode.UPTIME_STATUS

          • uptime: Uint32

        • DebugSubOpcode.LAST_SW_FAULT_GET

        • DebugSubOpcode.LAST_SW_FAULT_CLEAR

        • DebugSubOpcode.LAST_SW_FAULT_STATUS

          • time: Uint32

          • fault: bytes

        • DebugSubOpcode.SYSTEM_STATS_GET

        • DebugSubOpcode.SYSTEM_STATS_STATUS
          • stats: Range of Struct of

            • name: bytes

            • high_water_mark: Uint32

        • DebugSubOpcode.LAST_MALLOC_FAULT_GET

        • DebugSubOpcode.LAST_MALLOC_FAULT_CLEAR

        • DebugSubOpcode.LAST_MALLOC_FAULT_STATUS

          • time: Uint32

          • fault: bytes

        • DebugSubOpcode.LAST_FDS_FAULT_GET

        • DebugSubOpcode.LAST_FDS_FAULT_CLEAR

        • DebugSubOpcode.LAST_FDS_FAULT_STATUS

          • time: Uint32

          • fault: bytes

        • DebugSubOpcode.BYTES_BEFORE_GARBAGE_COLLECTOR_GET

        • DebugSubOpcode.BYTES_BEFORE_GARBAGE_COLLECTOR_STATUS

          • bytes_left: Uint16

        • DebugSubOpcode.PROVISIONED_APP_VERSION_GET

        • DebugSubOpcode.PROVISIONED_APP_VERSION_STATUS

          • version: Uint16

        • DebugSubOpcode.FULL_FIRMWARE_VERSION_GET

        • DebugSubOpcode.FULL_FIRMWARE_VERSION_STATUS

          • version: bytes

        • DebugSubOpcode.IV_INDEX_GET

        • DebugSubOpcode.IV_INDEX_STATUS

          • ivindex: Uint32

        • DebugSubOpcode.GARBAGE_COLLECTOR_COUNTER_GET

        • DebugSubOpcode.GARBAGE_COLLECTOR_COUNTER_STATUS

          • counter: Uint16

        • DebugSubOpcode.ARAP_LIST_SIZE_GET

        • 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: Uint32

  • params: Switch by opcode
    • NetworkDiagnosticServerOpcode.SILVAIR_NDS

      • subopcode: Enum of NetworkDiagnosticServerSubOpcode as Uint8

      • payload: Switch by subopcode

        • NetworkDiagnosticServerSubOpcode.SUBSCRIPTION_GET

        • NetworkDiagnosticServerSubOpcode.SUBSCRIPTION_SET

          • destination: Uint16

          • period: Uint16

        • NetworkDiagnosticServerSubOpcode.SUBSCRIPTION_SET_UNACKNOWLEDGED

          • destination: Uint16

          • period: Uint16

        • NetworkDiagnosticServerSubOpcode.SUBSCRIPTION_STATUS

          • destination: Uint16

          • period: Uint16

          • max_record_count: Uint8

          • record: Range of Struct of

            • source: Uint16

            • count: Uint16

            • min_hops: Uint8

            • max_hops: Uint8

        • NetworkDiagnosticServerSubOpcode.RADIO_STAT_GET

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: Uint32

  • params: Switch by opcode
    • NetworkDiagnosticSetupServerOpcode.SILVAIR_NDS_SETUP

      • subopcode: Enum of NetworkDiagnosticSetupServerSubOpcode as Uint8

      • payload: Switch by subopcode

        • NetworkDiagnosticSetupServerSubOpcode.PUBLICATION_GET

        • NetworkDiagnosticSetupServerSubOpcode.PUBLICATION_SET
          • optional: Struct of

            • destination: Uint16

            • count: Uint16

            • period: Struct of

              • resolution: Uint2

              • steps: Uint6

            • ttl: Uint8

            • net_key_index: Uint16

            • features: Uint16

          • minimal: Struct of

            • destination: Uint16

            • count: Uint16

            • period: Struct of

              • resolution: Uint2

              • steps: Uint6

            • ttl: Uint8

            • net_key_index: Uint16

        • NetworkDiagnosticSetupServerSubOpcode.PUBLICATION_STATUS
          • optional: Struct of

            • destination: Uint16

            • count: Uint16

            • period: Struct of

              • resolution: Uint2

              • steps: Uint6

            • ttl: Uint8

            • net_key_index: Uint16

            • features: Uint16

          • minimal: Struct of

            • destination: Uint16

            • count: Uint16

            • period: Struct of

              • resolution: Uint2

              • steps: Uint6

            • ttl: Uint8

            • net_key_index: Uint16