core/no.nordicsemi.kotlin.mesh.core.model

Package-level declarations

Types

Address

typealias Address = UShort

Type alias for an unsigned 16-bit address.

AddressRange

@Serializable

sealed class AddressRange : Range

Allocated address range.

AllFriends

object AllFriends : FixedGroupAddress, SubscriptionAddress

A message sent to the all-friends address shall be processed by the primary element of all nodes that have the friend functionality enabled.

AllNodes

data object AllNodes : FixedGroupAddress

A message sent to the all-nodes address shall be processed by the primary element of all nodes.

AllProxies

object AllProxies : FixedGroupAddress, SubscriptionAddress

A message sent to the all-proxies address shall be processed by the primary element of all nodes that have the proxy functionality enabled.

AllRelays

object AllRelays : FixedGroupAddress, SubscriptionAddress

A message sent to the all-relays address shall be processed by the primary element of all nodes that have the relay functionality enabled.

ApplicationKey

@Serializable

data class ApplicationKey

Application Keys are used to secure communications at the upper transport layer. The application key (AppKey) shall be generated using a random number generator compatible with the requirements in Volume 2, Part H, Section 2 of the Core Specification 1.

Credentials

@Serializable(with = CredentialsSerializer::class)

sealed class Credentials

The credentials property contains an integer of 0 or 1 that represents whether managed flooding security material (0) or friendship security material (1) is used.

Element

@Serializable

data class Element(val location: Location, _models: MutableList<Model> = mutableListOf())

Element represents a mesh element that is defined as an addressable entity within a mesh node.

Feature

@Serializable

sealed class Feature

Represents a type feature.

Features

@Serializable(with = FeaturesSerializer::class)

data class Features

Features represents the functionality of a Node that is determined by the set features that the node supports.

FeatureState

@Serializable

sealed class FeatureState

FeatureState describes the state of a given Feature.

FixedGroupAddress

@Serializable

sealed class FixedGroupAddress : MeshAddress, ProxyFilterAddress

There are two types of group address; those that can be assigned dynamically and those that are fixed. Fixed group addresses are in the range of 0xFF00 through 0xFFFF.

Friend

@Serializable

data class Friend : Feature

Friend feature is the ability to operate within a mesh network at significantly reduced receiver duty cycles only in conjunction with a node supporting the Friend feature.

FriendshipSecurity

@Serializable(with = CredentialsSerializer::class)

data object FriendshipSecurity : Credentials

Friendship security material is used for Publishing.

Group

@Serializable

data class Group(_name: String, val address: PrimaryGroupAddress)

Group defines a GroupAddress of type PrimaryGroupAddress to which a node may subscribe to.

GroupAddress

@Serializable(with = MeshAddressSerializer::class)

data class GroupAddress(val address: Address) : MeshAddress, PrimaryGroupAddress, ParentGroupAddress, PublicationAddress, SubscriptionAddress, HeartbeatPublicationDestination, HeartbeatSubscriptionDestination, ProxyFilterAddress

A group address is an address that is programmed into zero or more elements. A group address has bit 15 set to 1 and bit 14 set to 1. Group addresses in the range 0xFF00 through 0xFFFF are reserved for FixedGroupAddress, and addresses in the range 0xC000 through 0xFEFF are generally available for other usage.

GroupRange

@Serializable

data class GroupRange(val lowAddress: GroupAddress, val highAddress: GroupAddress) : AddressRange

The AllocatedGroupRange represents the range of group addresses that the Provisioner can allocate to newly created groups, without needing to coordinate the group additions with other Provisioners. The lowAddress and highAddress properties represent values from 0xC000 to 0xFEFF. The value of the lowAddress property shall be less than or equal to the value of the highAddress property.

HasAddress

interface HasAddress

An interface containing a property type address.

HeartbeatDestination

interface HeartbeatDestination : HasAddress

An address that is used as a destination address by a Heartbeat Publication or a Heartbeat Subscription message. This represents a UnicastAddress, GroupAddress.

HeartbeatPublication

@Serializable

data class HeartbeatPublication

The heartbeat publication represents parameters that define the sending of periodic Heartbeat transport control messages.

HeartbeatPublicationDestination

interface HeartbeatPublicationDestination : HeartbeatDestination

Heartbeat publication destination address for heartbeat messages. This represents a UnicastAddress, GroupAddress or an UnassignedAddress.

HeartbeatSubscription

@Serializable

data class HeartbeatSubscription

The heartbeat subscription object represents parameters that define the receiving of periodical Heartbeat transport control messages.

HeartbeatSubscriptionDestination

interface HeartbeatSubscriptionDestination : HeartbeatDestination

Heartbeat subscription destination address for heartbeat messages. This represents a UnicastAddress or a GroupAddress.

HeartbeatSubscriptionSource

interface HeartbeatSubscriptionSource : HasAddress

Heartbeat subscription source address for heartbeat messages. This represents a UnicastAddress.

Insecure

data object Insecure : Security

Describes an insecure security level.

IvIndex

data class IvIndex(val index: UInt, val isIvUpdateActive: Boolean = false, val transitionDate: Instant = Clock.System.now())

The IV Index received with the last Secure Network Beacon and its current state.

KeyDistribution

object KeyDistribution : KeyRefreshPhase

First phase of Key Refresh procedure, distributes new keys to all nodes. Nodes will transmit using old keys, but can receive using old and new keys.

KeyIndex

typealias KeyIndex = UShort

A Key Index is 12-bit long Unsigned Integer. This property returns true if the value is in range 0...4095.

KeyRefreshPhase

@Serializable(with = KeyRefreshPhaseSerializer::class)

sealed class KeyRefreshPhase

The Key Refresh Phase state indicates and controls the Key Refresh procedure for each NetKey in the NetKey List.

Location

enum Location : Enum<Location>

Locations defined by bluetooth SIG. Refer: https://www.bluetooth.com/specifications/assigned-numbers/gatt-namespace-descriptors

LowPower

@Serializable

data class LowPower : Feature

LowPower feature is the ability to help a node supporting the Low Power feature to operate by storing messages destined for those nodes.

MasterSecurity

@Serializable(with = CredentialsSerializer::class)

data object MasterSecurity : Credentials

Master security material is used for Publishing.

MeshAddress

@Serializable(with = MeshAddressSerializer::class)

sealed class MeshAddress : HasAddress

Wrapper class for Address.

MeshNetwork

@Serializable

class MeshNetwork

MeshNetwork representing a Bluetooth mesh network.

Model

@Serializable

data class Model

Represents Bluetooth mesh model contained in an element in a node.

ModelId

@Serializable(with = ModelIdSerializer::class)

sealed class ModelId

Represents Model ID of a Bluetooth mesh model.

NetworkKey

@Serializable

data class NetworkKey

AThe network key object represents the state of the mesh network key that is used for securing communication at the network layer.

NetworkTransmit

@Serializable

data class NetworkTransmit

The network transmit object represents the parameters of the transmissions of network layer messages originating from a mesh node.

Node

@Serializable

data class Node

The node represents a configured state of a mesh node.

NodeKey

@Serializable

data class NodeKey

The state of a NetworkKey or ApplicationKey distributed to a mesh node by a Mesh Manager.

NormalOperation

object NormalOperation : KeyRefreshPhase

Normal operation; Key Refresh procedure is not active.

ParentGroupAddress

@Serializable(with = MeshAddressSerializer::class)

interface ParentGroupAddress : HasAddress

An address type used to identify a GroupAddress, VirtualAddress or an UnassignedAddress that's used as a parent address of a group. Parent group address cannot be a fixed group address and not allocatable to a provisioner as a range.

PrimaryGroupAddress

@Serializable(with = MeshAddressSerializer::class)

interface PrimaryGroupAddress : HasAddress

An address type used to identify a GroupAddress or a VirtualAddress that's used to create a group. Primary group address cannot be a fixed group address and not allocatable to a provisioner as a range.

Provisioner

@Serializable

data class Provisioner

A Provisioner is capable of provisioning a device to a mesh network and is represented by a provisioner object in the Mesh Configuration Database. A provisioner is represented as a node in mesh network only if it is assigned a unicast address. Having a unicast address assigned allows configuring nodes in the mesh network. Otherwise, a provisioner can only provision nodes to a mesh network.

Proxy

@Serializable

data class Proxy : Feature

Proxy feature is the ability to receive and retransmit mesh messages between GATT and advertising bearers.

ProxyFilterAddress

@Serializable(with = MeshAddressSerializer::class)

interface ProxyFilterAddress : HasAddress

An address type that can be added to a Proxy Filter List. This represents a UnicastAddress, GroupAddress, VirtualAddress or a FixedGroupAddress.

PublicationAddress

@Serializable(with = MeshAddressSerializer::class)

interface PublicationAddress : HasAddress

An address a model may publish to. This represents a UnicastAddress, GroupAddress or a VirtualAddress.

Publish

@Serializable

data class Publish(val address: PublicationAddress, val index: KeyIndex, val ttl: UByte, val period: PublishPeriod, val credentials: Credentials, val retransmit: Retransmit)

The publish object represents parameters that define how the messages are published by a mesh model.

PublishPeriod

@Serializable

data class PublishPeriod(val steps: UByte, val resolution: StepResolution)

The publish period object determines the interval at which messages are published by a model and is defined by two values: the number of steps and step resolution. The publish period is calculated as a product of the number of steps and step resolution. For example, if the value of the numberOfSteps property is 3 and the value of the resolution property is 1000, the publish period is 3000 ms.

Range

@Serializable

sealed class Range

Allocated Range.

Relay

@Serializable

data class Relay : Feature

Relay feature is the ability to receive and retransmit mesh messages over the advertising bearer to enable larger networks.

RelayRetransmit

@Serializable

data class RelayRetransmit

The relay retransmit object represents the parameters of the retransmissions of network layer messages relayed by a mesh node.

Retransmit

@Serializable

data class Retransmit(val count: UByte, val interval: Duration)

The retransmit object is used to describe the number of times a message is published and the interval between retransmissions of the published messages.

Scene

@Serializable

data class Scene

Scene

SceneNumber

typealias SceneNumber = UShort

SceneRange

@Serializable

data class SceneRange(val firstScene: SceneNumber, val lastScene: SceneNumber) : Range

The AllocatedSceneRange represents the range of scene numbers that the Provisioner can use to register new scenes in the mesh network, without needing to coordinate the allocated scene numbers with other Provisioners. The firstScene and lastScene represents values from 0x0001 to 0xFFFF. The value of the firstScene property shall be less than or equal to the value of the lastScene property.

Secure

data object Secure : Security

Describes a secure security level.

Security

@Serializable(with = SecuritySerializer::class)

sealed class Security

Security level describes a minimum security level of a subnet associated with this network key. If all the nodes on the subnet associated with this network key have been provisioned using the Secure Provisioning procedure 1, then the value of minSecurity property for the subnet is set to “secure”; otherwise, the value of the minSecurity is set to “insecure”.

SigModelId

@Serializable

data class SigModelId(val modelIdentifier: UShort) : ModelId

Wrapper class for 16-bit Bluetooth SIG model identifier.

StepResolution

enum StepResolution : Enum<StepResolution>

Mesh implementation of step resolution is a 2-bit field that enumerates the number of steps.

SubscriptionAddress

@Serializable(with = MeshAddressSerializer::class)

interface SubscriptionAddress : HasAddress

An address a model may subscribe to. This represents a GroupAddress, VirtualAddress, AllProxies, AllFriends or an AllRelays address.

TransitionTime

data class TransitionTime(val steps: UByte, val stepResolution: StepResolution)

This structure represents a time needed to transition from one state to another, for example dimming a light.

UnassignedAddress

@Serializable(with = MeshAddressSerializer::class)

object UnassignedAddress : MeshAddress, ParentGroupAddress, PublicationAddress, SubscriptionAddress, HeartbeatPublicationDestination, HeartbeatSubscriptionDestination

The unassigned address has the value 0x0000.

UnicastAddress

@Serializable(with = MeshAddressSerializer::class)

data class UnicastAddress(val address: Address) : MeshAddress, PublicationAddress, HeartbeatPublicationDestination, HeartbeatSubscriptionSource, HeartbeatSubscriptionDestination, ProxyFilterAddress

A unicast address is a unique address allocated to each element. A unicast address has bit 15 set to 0. The unicast address shall not have the value 0x0000, and therefore can have any value from 0x0001 to 0x7FFF inclusive.

UnicastRange

@Serializable

data class UnicastRange(val lowAddress: UnicastAddress, val highAddress: UnicastAddress) : AddressRange

The AllocatedUnicastRange represents the range of unicast addresses that the Provisioner can allocate to new devices when they are provisioned onto the mesh network, without needing to coordinate the node additions with other Provisioners. The lowAddress and highAddress represent values from 0x0001 to 0x7FFF. The value of the lowAddress property shall be less than or equal to the value of the highAddress property.

UsingNewKeys

object UsingNewKeys : KeyRefreshPhase

Second phase of Key Refresh procedure, nodes will use the new keys when encrypting messages but will still receive using the old or new keys. Nodes shall only receive Secure Network beacons secured using the new Network Key.

VendorModelId

@Serializable

data class VendorModelId : ModelId

Wrapper class for 32-bit vendor model identifier.

VirtualAddress

@Serializable(with = MeshAddressSerializer::class)

data class VirtualAddress(val uuid: UUID) : MeshAddress, PrimaryGroupAddress, ParentGroupAddress, PublicationAddress, SubscriptionAddress, ProxyFilterAddress

A virtual address represents a set of destination addresses. Each virtual address logically represents a Label UUID, which is a 128-bit value that does not have to be managed centrally. One or more elements may be programmed to publish or subscribe to a Label UUID. The Label UUID is not transmitted and shall be used as the Additional Data field of the message integrity check value in the upper transport layer.