core/no.nordicsemi.kotlin.mesh.core.messages.foundation.configuration

Package-level declarations

Types

CompositionDataPage

interface CompositionDataPage

Base interface for a Composition Data Page.

ConfigCompositionDataGet

data class ConfigCompositionDataGet(val page: UByte) : AcknowledgedConfigMessage

This message is used to get the Heartbeat Publication state of an element.

ConfigCompositionDataStatus

data class ConfigCompositionDataStatus(val page: CompositionDataPage) : ConfigResponse

This message is the response received when requesting the composition data of a Node using ConfigCompositionDataGet message.

ConfigGattProxyGet

class ConfigGattProxyGet : AcknowledgedConfigMessage

Defines message sent to request the Current GATT Proxy state of the Node. ConfigGattProxyStatus will be the response to this message.

ConfigGattProxySet

data class ConfigGattProxySet(val state: FeatureState) : AcknowledgedConfigMessage

Defines message sent to set the Current GATT Proxy state of the Node. ConfigGattProxyStatus will be the response to this message.

ConfigGattProxyStatus

data class ConfigGattProxyStatus(val state: FeatureState) : ConfigResponse

Defines the response to ConfigGattProxyGet.

ConfigHeartbeatPublicationGet

class ConfigHeartbeatPublicationGet : AcknowledgedConfigMessage

This message is used to get the Heartbeat Publication state of an element.

ConfigHeartbeatPublicationSet

class ConfigHeartbeatPublicationSet(val destination: Address = UnassignedAddress.address, val countLog: CountLog, val periodLog: UByte, val ttl: UByte, val features: Array<Feature>, val networkKeyIndex: KeyIndex) : AcknowledgedConfigMessage, ConfigNetKeyMessage

This message can be sent to set Heartbeat Publication of a given element.

ConfigHeartbeatPublicationStatus

data class ConfigHeartbeatPublicationStatus(val destination: HeartbeatPublicationDestination = UnassignedAddress, val countLog: CountLog = 0x00.toUByte(), val periodLog: UByte = 0x00.toUByte(), val ttl: UByte = 0x00.toUByte(), val features: Array<Feature> = emptyArray(), val networkKeyIndex: KeyIndex, val status: ConfigMessageStatus = ConfigMessageStatus.SUCCESS) : ConfigResponse, ConfigStatusMessage

This message contains the Heartbeat Publication status of an element. This is sent in response to a ConfigHeartbeatPublicationGet or ConfigHeartbeatPublicationSet message.

ConfigModelPublicationGet

data class ConfigModelPublicationGet(val elementAddress: UnicastAddress, val modelIdentifier: UShort, val companyIdentifier: UShort?) : AcknowledgedConfigMessage, ConfigAnyModelMessage

This message is used to get the publication state of a model.

ConfigModelPublicationSet

data class ConfigModelPublicationSet(val publish: Publish, val companyIdentifier: UShort?, val modelIdentifier: UShort, val elementAddress: UnicastAddress) : AcknowledgedConfigMessage, ConfigAnyModelMessage

This message is used to set the publication state of a model.

ConfigModelPublicationStatus

data class ConfigModelPublicationStatus(val publish: Publish, val elementAddress: UnicastAddress, val modelIdentifier: UShort, val companyIdentifier: UShort?, val status: ConfigMessageStatus = ConfigMessageStatus.SUCCESS) : ConfigResponse, ConfigStatusMessage, ConfigAnyModelMessage

This message is used to set the publication state of a model.

ConfigModelPublicationVirtualAddressSet

data class ConfigModelPublicationVirtualAddressSet(val publish: Publish, val companyIdentifier: UShort?, val modelIdentifier: UShort, val elementAddress: UnicastAddress) : AcknowledgedConfigMessage, ConfigAnyModelMessage

This message is used to set the publication state of a model.

ConfigNetKeyDelete

data class ConfigNetKeyDelete(val networkKeyIndex: KeyIndex) : AcknowledgedConfigMessage, ConfigNetKeyMessage

This message is used to delete a network key from the mesh network.

ConfigNetKeyStatus

data class ConfigNetKeyStatus(val networkKeyIndex: KeyIndex, val status: ConfigMessageStatus) : ConfigResponse, ConfigStatusMessage, ConfigNetKeyMessage

Status declaring if the the ConfigNetKeyMessage operation succeeded or not.

ConfigNodeReset

class ConfigNodeReset : AcknowledgedConfigMessage

This message is used to reset the node and will be reset to the unprovisioned state.

ConfigNodeResetStatus

class ConfigNodeResetStatus : ConfigResponse

Status message received when after sending a ConfigNodeReset message.

typealias CountLog = UByte

data class Page0(val page: UByte, val companyIdentifier: UShort, val productIdentifier: UShort, val versionIdentifier: UShort, val minimumNumberOfReplayProtectionList: UShort, val features: Features, val elements: List<Element>) : CompositionDataPage

Composition Data Page 0 shall be present on a Node.