Package-level declarations

Types

Link copied to clipboard
enum Action : Enum<Action>

Represents action to be triggered when specified Condition is met.

Link copied to clipboard

Represents advertisement manufacturer specific data format.

data class AmbientLightDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>
data class AmbientLightLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
data class AmmoniaDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class AmmoniaLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class AtmosphericPressureLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
Link copied to clipboard
data class BatteryStatistics(val batteryStatus: BatteryStatistics.BatteryStatus, val batteryVoltage: Int, val mcuTemperature: Int, val batteryMinVoltage: Int, val batteryMinTemperature: Int, val batteryResetTimestamp: Long, val mcuMaxTemperature: Int, val mcuMinTemperature: Int)

Represents battery statistics information

Link copied to clipboard
Link copied to clipboard
sealed interface BluetoothAdvertisingMode

Represents the advertising mode for Bluetooth sensors.

Link copied to clipboard
sealed interface BluetoothTurnOff

Bluetooth turn off configuration. It can be set to always on or after specified time. Note that if the BLE interface is switched off, it is impossible to access the sensor through the mobile application.

data class BreathVOCDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class BreathVOCLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class CarbonDioxideDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class CarbonDioxideEquivalentLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class CarbonDioxideLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class CarbonMonoxideDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class CarbonMonoxideLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
Link copied to clipboard
sealed class Condition

Represents condition to be checked by the device. If the condition is true, an Action is triggered.

Link copied to clipboard
sealed interface ConditionParameters
Link copied to clipboard
data class ConfigurationErrors(val lastErrorTimestamp: Long?, val errors: List<Int>)

Represents information about device configuration errors

data class CurrentDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>
data class CurrentLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
data class CurrentPreciseDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>
data class CurrentPreciseLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
data class DifferentialPressureDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class DifferentialPressureLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
Link copied to clipboard
data class DistanceDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class DistanceLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class ElectricityUsageAccumulatedLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
data class ElectricityUsageDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class ElectricityUsageLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class HighPressureDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class HighPressureLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class HumidityAccurateDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>
data class HumidityAccurateLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
data class HumidityDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class HumidityLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class HydrogenSulfideDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>
data class HydrogenSulfideLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
data class InternalAirQualityDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class InternalAirQualityLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class InternalAirQualityStaticLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
Link copied to clipboard
data class LedConfiguration(val greenLedPeriod: Int, val redLedPeriod: Int, val communicationErrorLedTurnoffTime: Int, val sensorErrorLedTurnoffTime: Int, val lowPowerLedTurnoffTime: Int, val newMeasurementLedTurnoffTime: Int, val transmissionLedTurnoffTime: Int, val sensorOkLedTurnoffTime: Int, val blinkTime: Int)

Represents device LEDs configuration

Link copied to clipboard
Link copied to clipboard
data class LogicOperatorConditionParameters(val logicOperator: LogicOperator, val selectedRules: Set<Int>, val negatedRules: Set<Int>, val actionDelay: Int?, val returnDelay: Int?) : ConditionParameters
Link copied to clipboard
data class MeasurementsPacket(val period: Int, val periodFactor: Int?, val measurements: List<MeasurementsPacket.TimestampedMeasurement>)

Packet of measurements having the same period and periodFactor.

Link copied to clipboard
data class MemoryStatistics(val nvStorageStatus: MemoryStatistics.NvStorageStatus, val collectingTimestamp: Long?, val capacityInBytes: Int, val usedSpaceInBytes: Int, val invalidPacketsSizeInBytes: Int, val corruptedPacketsSizeInBytes: Int, val validPacketsNumber: Int, val invalidPacketsNumber: Int, val corruptedPacketsNumber: Int, val samplesNumber: Map<Channel, Int>, val firstBinaryMeasurementTimestamp: Long?, val lastBinaryMeasurementTimestamp: Long?, val lastSentBinaryMeasurementTimestamp: Long?, val firstContinuousMeasurementTimestamp: Long?, val lastContinuousMeasurementTimestamp: Long?, val lastSentContinuousMeasurementTimestamp: Long?, val nvmWriteCounter: Int?)

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

data class MethaneDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class MethaneLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class NitrogenDioxideDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class NitrogenDioxideLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class NoiseLevelDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>
data class NoiseLevelLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
Link copied to clipboard

Represents non-volatile memory status.

Link copied to clipboard
data class OnMeasurementConditionParameters(val measurementInterval: Int, val selectedRules: Set<Int>, val negatedRules: Set<Int>) : ConditionParameters
Link copied to clipboard
Link copied to clipboard
data class ParticulateMatter10DifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class ParticulateMatter10LowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class ParticulateMatter1DifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class ParticulateMatter1LowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class ParticulateMatter2_5DifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class ParticulateMatter2_5LowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class PercentageDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>
data class PercentageLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
data class PulsesAccumulatedDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class PulsesAccumulatedLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class PulsesAccumulatedWideLowHighThresholdConditionParameters(val thresholdValue: Long, val hysteresisValue: Long?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Long>
data class PulsesDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class PulsesLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class ResistanceDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class ResistanceLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
Link copied to clipboard
data class Rule(val id: Int, val channels: Set<Channel>, val condition: Condition, val action: Action)

Represents rule used to define edge logic on the device.

Link copied to clipboard
data class RuleCalendar(val id: Int, val selectedRules: Set<Int>, val type: RuleCalendar.Type)

Rule calendar is used for enabling/disabling rules based on date/time.

Link copied to clipboard
sealed class RuntimeError
Link copied to clipboard
data class RuntimeInfo(val upTime: Int, val messageCounters: RuntimeInfo.MessageCounters, val batteryVoltage: Int?, val mcuTemperature: Int, val maxMcuTemperature: Int, val minMcuTemperature: Int, val runtimeErrors: List<RuntimeError>, val resetCounter: Int)

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

Link copied to clipboard
data class SelfTestData(val availableTests: List<SelfTestData.Test>, val externalFlashInfo: SelfTestData.ExternalFlashInfo?, val batteryVoltage: Double, val measurements: Map<Int, Measurement<*>>, val buttonState: SelfTestData.ButtonState?, val imei: String?, val iccid: String?, val modemVersion: String?, val modemApplicationVersion: String?)
Link copied to clipboard
data class SensorConfiguration(val serialNumber: String? = null, val payloadSplitInfo: Int? = null, val configurationHash: Int? = null, val configurationHashTimestamp: Long? = null, val configurationErrors: ConfigurationErrors? = null, val measurementTypes: Map<Channel, Measurement.Type>? = null, val nvmStatus: NVMStatus? = null, val currentTime: Long? = null, val acceptWithoutTestingRequest: Boolean? = null, val configurationRequest: Boolean? = null, val deviceInfoRequest: Boolean? = null, val extendedConfigurationRequest: Boolean? = null, val updateSoftwareRequest: Boolean? = null, val clearRuntimeErrorsRequest: Boolean? = null, val disableModemAfterTimeRequest: Int? = null, val updateModemRequest: String? = null, val resetMemoryRequest: Boolean? = null, val restartMemoryStatsRequest: Boolean? = null, val dataTransferStartTimestampRequest: Long? = null, val setOutputControlStateRequest: Map<Channel, Boolean>? = null, val measurementPeriod: MeasurementPeriod? = null, val bluetoothTurnoff: BluetoothTurnOff? = null, val bluetoothTxPowerLevel: TxPowerLevel? = null, val encryptionKey: String? = null, val bluetoothAdvertisingMode: BluetoothAdvertisingMode? = null, val advertisementManufacturerDataFormat: AdvertisementManufacturerDataFormat? = null, val rules: List<Rule>? = null, val ruleCalendars: List<RuleCalendar>? = null, val transmissionInterval: TransmissionInterval? = null, val ackInterval: AckInterval? = null, val transferLimit: TransferLimit? = null, val transferLimitTimer: TransferLimitTimer? = null, val supervisionPeriod: SupervisionPeriod? = null, val dataServerAddress: IpAddressOrHostname? = null, val dataServerPort: Port? = null, val dataEndpoint: String? = null, val configurationEndpoint: String? = null, val extendedConfigurationEndpoint: String? = null, val deviceInfoEndpoint: String? = null, val timeEndpoint: String? = null, val updateServerAddress: IpAddressOrHostname? = null, val updateServerPortUdp: Port? = null, val updateServerPortCoap: Port? = null, val cloudTokenConfiguration: CloudTokenConfiguration? = null, val cloudTokenCoapOption: CloudTokenCoapOption? = null, val payloadSignatureCoapOption: PayloadSignatureCoapOption? = null, val modemIdentificationCoapOption: ModemIdentificationCoapOption? = null, val dnsIp: IpAddress? = null, val dnsConfiguration: DnsConfiguration? = null, val networkTroubleshootingEnabled: Boolean? = null, val networkKey: String? = null, val apn: Apn? = null, val plmn: Plmn? = null, val modemBands: List<CellularBand>? = null, val cellularConfiguration: CellularConfiguration? = null, val networkSearch: NetworkSearch? = null, val ledConfiguration: LedConfiguration? = null)

Configuration settings for a sensor device.

Link copied to clipboard

Represents an error related to sensor configuration.

Link copied to clipboard
data class SensorDeviceInfo(val serialNumber: String, val softwareVersion: SoftwareVersion, val runtimeInfo: RuntimeInfo, val memoryStatistics: MemoryStatistics, val lastUpdateInfo: UpdateInfo, val modem: Modem?)

This data class represents the information retrieved from a sensor device.

Link copied to clipboard
data class SensorExtendedConfiguration(val serialNumber: String? = null, val configurationHash: Int? = null, val laboratoryCalibrationTimestamp: Long? = null, val channelCalibration: Map<Channel, Calibration>? = null, val sensorName: String? = null)

Extended configuration settings for a sensor device.

Link copied to clipboard
data class SensorHardwareVersion(val powerSupply: SensorHardwareVersion.PowerSupplyType, val communicationInterface: SensorHardwareVersion.CommunicationInterface, val features: Set<SensorHardwareVersion.DeviceFeature>, val hardwareVersion: String, val model: String)

Represents the hardware version of a sensor device.

Link copied to clipboard

Represents notification used by legacy sensors

Link copied to clipboard

Represents information about sensor installed on the device

Link copied to clipboard
sealed class SensorNotification

Represents notification used by sensors

data class SoilMoistureDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class SoilMoistureLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>
data class TemperatureDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>
data class TemperatureLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
Link copied to clipboard
data class TimeInformation(val timeStamp: Long, val event: TimeInformation.Event, val elapsedSecondsSinceEvent: Long, val measurementSynchronizationFinished: Sensor.TimeSynchronizationStatus?, val timeSynchronizationPeriodInSeconds: Int?)
Link copied to clipboard
Link copied to clipboard

Represents the transmission (tx) power level of bluetooth module installed on the sensor.

Link copied to clipboard
Link copied to clipboard
data class UpdateInfo(val timestamp: Long, val status: UpdateInfo.Status?)

This class holds information about the last update of the sensor device.

data class VoltageDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>
data class VoltageLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
data class WaterUsageAccumulatedLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>
data class WaterUsageDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>
data class WaterUsageLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>