provisioning/no.nordicsemi.kotlin.mesh.provisioning

Package-level declarations

Types

AddressNotSpecified

data object AddressNotSpecified : ProvisioningError

Throws when the Unicast Address has not been set.

sealed class AuthAction

Defines a set of authentication methods aimed at strengthening the provisioning process.

AuthenticationMethod

sealed class AuthenticationMethod

The type authentication method chosen for provisioning.

ConfirmationFailed

data object ConfirmationFailed : ProvisioningError

Thrown when confirmation value received from the device does not match calculated value. Authentication failed.

enum InputAction : Enum<InputAction>

InputOobActions

sealed class InputOobActions

A set of support Input out-of-band actions.

data object InvalidAddress : ProvisioningError

Thrown when the unicast address is invalid.

InvalidOobValueFormat

data object InvalidOobValueFormat : ProvisioningError

Thrown when the provided alphanumeric value could not be converted into bytes using ASCII encoding.

data object InvalidPdu : ProvisioningError

The received PDU is invalid.

InvalidPublicKey

data object InvalidPublicKey : ProvisioningError

The received Public Key is invalid or not equal to Provisioner's Public Key.

data object InvalidState : ProvisioningError

Thrown when the ProvisioningManager is in an invalid state.

KeyGenerationFailed

data class KeyGenerationFailed(val throwable: Throwable) : ProvisioningError

Thrown when the key pair generation has failed.

NetworkKeyNotSpecified

data object NetworkKeyNotSpecified : ProvisioningError

Throws when the Network Key has not been set.

NoAddressAvailable

data object NoAddressAvailable : ProvisioningError

Thrown when no available Unicast Address was found in the Provisioner's range that could be allocated for the device.

sealed class OobType

A set of Out-of-band types.

enum OutputAction : Enum<OutputAction>

OutputOobActions

sealed class OutputOobActions

A set of support Output out-of-band actions.

ProvisioningCapabilities

data class ProvisioningCapabilities(val numberOfElements: Int, val algorithms: List<Algorithms>, val publicKeyType: List<PublicKeyType>, val oobTypes: List<OobType>, val outputOobSize: UByte, val outputOobActions: List<OutputOobActions>, val inputOobSize: UByte, val inputOobActions: List<InputOobActions>)

The device sends this PDU to indicate the supported capabilities to a provisioner.

ProvisioningError

sealed class ProvisioningError : Exception

Set of errors which may be thrown during provisioning a device.

ProvisioningManager

class ProvisioningManager(unprovisionedDevice: UnprovisionedDevice, meshNetwork: MeshNetwork, val bearer: MeshProvisioningBearer)

Provisioning manager is responsible for provisioning new devices to a mesh network.

ProvisioningParameters

data class ProvisioningParameters

Configuration class that contains all the necessary information to provision a device.

ProvisioningRequest

sealed class ProvisioningRequest

Provisioning requests are sent by the Provisioner to an unprovisioned device.

ProvisioningResponse

sealed class ProvisioningResponse

Provisioning responses are sent by the Provisionee to the Provisioner. as a response to a ProvisioningRequest.

ProvisioningState

sealed class ProvisioningState

Defines possible state of provisioning process.

sealed class PublicKey

Defines Public Key type that's supported by the device. This field is received as a part of the Provisioning Capabilities PDU.

PublicKeyMethod

enum PublicKeyMethod : Enum<PublicKeyMethod>

The type of Device Public key to be used.

sealed class PublicKeyType

Type of public key information.

data class RemoteError(val error: RemoteProvisioningError) : ProvisioningError

Thrown when the remove device sent a failure indication.

RemoteProvisioningError

enum RemoteProvisioningError : Enum<RemoteProvisioningError>

Set of errors which may be reported by an unprovisioned device during provisioning process.

UnprovisionedDevice

data class UnprovisionedDevice(var name: String, val uuid: UUID, val oobInformation: OobInformation = OobInformation.None)

UnsupportedDevice

data object UnsupportedDevice : ProvisioningError

Thrown when the Unprovisioned Device is not supported by the manager.