Package-level declarations

Types

Link copied to clipboard
sealed interface AckInterval

Represents ACK configuration

Link copied to clipboard

Represents cellular band

Link copied to clipboard
sealed interface CellularConfiguration
Link copied to clipboard

Represents cellular configuration parameters for different modem types.

Link copied to clipboard
data class CellularModuleStatistics(val dataTimestamp: Long, val lastSuccessfulRegistrationTimestamp: Long, val registrationStatus: RegistrationStatus, val modemParameters: ModemParameters)

Represents cellular module statistics information

Link copied to clipboard
data class CellularNetworkStatus(val commandVersion: Int, val serverCommunicationTimestamp: Long?, val serverCommunicationStatus: ServerCommunicationStatus, val supportedTechnologies: Set<CellularNetworkStatus.Technology>, val currentTechnology: CellularNetworkStatus.Technology?, val simCardStatus: CellularNetworkStatus.SimCardStatus?, val registrationStatus: RegistrationStatus, val registrationRejectCause: Int, val successfulRegistrationTimestamp: Long?, val ipAddress: IpAddress?, val rplmn: Int?, val trackingAreaCode: Int?, val cellId: Int?)

Represents network status of a cellular modem

Link copied to clipboard
data class CellularNetworkStatusLegacy(val supportedTechnologies: List<CellularNetworkStatusLegacy.SupportedTechnology>, val currentTechnology: CellularNetworkStatusLegacy.CurrentTechnology, val registrationStatus: RegistrationStatus, val signalStrength: Int?, val registrationRejectCause: String, val lastCommunicationTimestamp: Long?, val communicationStatus: CellularNetworkStatusLegacy.CommunicationStatus, val simCardStatus: CellularNetworkStatusLegacy.SimCardStatus, val ipAddress: IpAddress?, val cellId: String?, val trackingAreaCode: String?, val lastStatusCheckTimestamp: Long?, val secondsSinceLastReset: Int, val imei: String, val iccid: String)

Represents cellular network statistics

Link copied to clipboard
data class CloudAuthentication(val token: String, val tokenSource: CloudAuthentication.TokenSource, val cloudTokenCoapType: Int?, val payloadSignatureCoapType: Int?)

Represents cloud authentication features like cloud token, its configuration, CoAP options to send cloud token and ECDSA payload signature.

Link copied to clipboard
sealed interface CloudTokenCoapOption

Represents cloud token CoAP option.

Link copied to clipboard
sealed interface CloudTokenConfiguration

Represents configuration parameters of cloud token that will be used by the sensor for identification in Cloud

Link copied to clipboard
data class CoapEndpoint(val type: CoapEndpoint.Type, val endpoint: String)

Represents CoAP endpoint type

Link copied to clipboard
sealed interface DnsConfiguration

Represents dns configuration stored on sensor

Link copied to clipboard
data class Modem(val type: Modem.Type?, val firmwareVersion: Modem.FirmwareVersion?, val simCardIdentification: String?, val modemIdentification: String, val statistics: Modem.Statistics, val parameters: ModemParameters)

This data class holds information about the sensor device's modem.

Link copied to clipboard

Represents modem identification CoAP option.

Link copied to clipboard
sealed interface ModemLogConfiguration

Represents modem logging configuration

Link copied to clipboard

Represents modem log state

Link copied to clipboard
sealed interface ModemParameters
Link copied to clipboard
data class NetworkSearch(val lastRegistrationOkTimingInMinutes: List<Int>, val lastRegistrationErrorTimingInMinutes: List<Int>, val disablePeriodBaseInMinutes: Int, val disableCounterMax: Int)

Network search timing schema.

Link copied to clipboard

Represents payload signature CoAP option.

Link copied to clipboard

Represents sensors status of registration to cellular network

Link copied to clipboard
data class ServerCommunicationConfiguration(val transmissionInterval: TransmissionInterval, val ackInterval: AckInterval)

Represents configuration parameters of communication with server to which sensor sends data

Link copied to clipboard

Represents communication status

Link copied to clipboard
sealed interface ServerConfiguration

Represents configuration parameters of server to which sensor sends data

Link copied to clipboard
sealed interface SupervisionPeriod

Represents server supervision period configuration

Link copied to clipboard
sealed interface TransferLimit

Represents transfer limit configuration

Link copied to clipboard
data class TransferLimitConfiguration(val transferLimit: Int, val transferLimitTimer: Int)

Represents transfer limit configuration

Link copied to clipboard
sealed interface TransferLimitTimer

Represents transfer limit timer configuration

Link copied to clipboard
value class TransmissionInterval(val value: Int)