bluetooth/pl.efento.mobile.bluetooth.api/SensorLegacyCellularCommands

SensorLegacyCellularCommands

interface SensorLegacyCellularCommands

Functions

Link copied to clipboard
abstract suspend fun disableModem(disableTimeSeconds: Int, updateProgress: suspend (progress: Progress) -> Unit = {})

Detach the sensor from the network and turn the modem off for a defined period of time (max 7 days)

Link copied to clipboard
abstract suspend fun enterInstallationMode(updateProgress: suspend (progress: Progress) -> Unit = {})

Enter installation mode. In this mode, installation data is updated using notifications flow.

Link copied to clipboard
abstract suspend fun exitInstallationMode(updateProgress: suspend (progress: Progress) -> Unit = {})

Exit installation mode. After exit sensor will erase all measurements stored.

Link copied to clipboard
abstract suspend fun getApnConfiguration(updateProgress: suspend (progress: Progress) -> Unit = {}): Apn

Get network APN configuration

Link copied to clipboard
abstract suspend fun getCellularBands(updateProgress: suspend (progress: Progress) -> Unit = {}): List<CellularBand>

Gets cellular bands from sensor

Link copied to clipboard
abstract suspend fun getCellularConfiguration(updateProgress: suspend (progress: Progress) -> Unit = {}): CellularConfiguration

Get the cellular configuration from sensor

Link copied to clipboard
abstract suspend fun getCellularModuleStatistics(updateProgress: suspend (progress: Progress) -> Unit = {}): CellularModuleStatistics

Gets cellular module statistics from sensor

Link copied to clipboard
abstract suspend fun getCellularNetworkStatus(updateProgress: suspend (progress: Progress) -> Unit = {}): CellularNetworkStatusLegacy

Gets cellular network status from sensor

Link copied to clipboard
abstract suspend fun getCloudAuthentication(updateProgress: suspend (progress: Progress) -> Unit = {}): CloudAuthentication

Get cloud authentication features

Link copied to clipboard
abstract suspend fun getCloudTokenConfiguration(updateProgress: suspend (progress: Progress) -> Unit = {}): CloudTokenConfiguration

Get cloud token configuration

Link copied to clipboard
abstract suspend fun getCoapEndpoint(type: CoapEndpoint.Type, updateProgress: suspend (progress: Progress) -> Unit = {}): CoapEndpoint

Get CoAP endpoint

Link copied to clipboard
abstract suspend fun getCustomPLMNCode(updateProgress: suspend (progress: Progress) -> Unit = {}): Plmn

Get PLMN (Public Land Mobile Network) operator code

Link copied to clipboard
abstract suspend fun getDnsConfiguration(updateProgress: suspend (progress: Progress) -> Unit = {}): DnsConfiguration

Get DNS configuration

Link copied to clipboard
abstract suspend fun getDnsServer(updateProgress: suspend (progress: Progress) -> Unit = {}): IpAddress

Get DNS server IP address

Link copied to clipboard
abstract suspend fun getModemATLogState(updateProgress: suspend (progress: Progress) -> Unit = {}): Boolean

Get modem AT commands log state

Link copied to clipboard
abstract suspend fun getModemControl(updateProgress: suspend (progress: Progress) -> Unit = {}): Boolean?

Get modem control (is cellular modem enabled/disabled/not available)

Link copied to clipboard
abstract suspend fun getModemLogState(updateProgress: suspend (progress: Progress) -> Unit = {}): ModemLogState

Get modem log state

Link copied to clipboard
abstract suspend fun getNetworkTroubleshooting(updateProgress: suspend (progress: Progress) -> Unit = {}): Boolean

Get network troubleshooting configuration when communication with server is invalid

Link copied to clipboard
abstract suspend fun getServerCommunicationConfiguration(updateProgress: suspend (progress: Progress) -> Unit = {}): ServerCommunicationConfiguration

Get server communication configuration.

Link copied to clipboard
abstract suspend fun getServerConfigurations(updateProgress: suspend (progress: Progress) -> Unit = {}): List<ServerConfiguration>

Get server configuration

Link copied to clipboard
abstract suspend fun getServerTransferLimit(updateProgress: suspend (progress: Progress) -> Unit = {}): TransferLimitConfiguration

Get transfer limit to the server over a cellular module (initial number of tokens and initial timer settings).

Link copied to clipboard
abstract suspend fun getSupervisionPeriod(updateProgress: suspend (progress: Progress) -> Unit = {}): Int

Get supervision period

Link copied to clipboard
abstract suspend fun setApnConfiguration(apn: Apn, updateProgress: suspend (progress: Progress) -> Unit = {})

Set network APN configuration

Link copied to clipboard
abstract suspend fun setCellularBands(bands: List<CellularBand>, updateProgress: suspend (progress: Progress) -> Unit = {})

Set bands enabled on the sensor

Link copied to clipboard
abstract suspend fun setCellularConfiguration(cellularConfiguration: CellularConfiguration, updateProgress: suspend (progress: Progress) -> Unit = {})

Set the cellular configuration

Link copied to clipboard
abstract suspend fun setCloudAuthentication(cloudAuthentication: CloudAuthentication, updateProgress: suspend (progress: Progress) -> Unit = {})

Set cloud authentication features

Link copied to clipboard
abstract suspend fun setCloudTokenConfiguration(cloudTokenConfiguration: CloudTokenConfiguration, updateProgress: suspend (progress: Progress) -> Unit = {})

Set cloud token configuration

Link copied to clipboard
abstract suspend fun setCoapEndpoint(coapEndpoint: CoapEndpoint, updateProgress: suspend (progress: Progress) -> Unit = {})

Set CoAP endpoint

Link copied to clipboard
abstract suspend fun setCustomPlmnCode(plmn: Plmn, updateProgress: suspend (progress: Progress) -> Unit = {})

Set PLMN (Public Land Mobile Network) operator code

Link copied to clipboard
abstract suspend fun setDnsConfiguration(dnsConfiguration: DnsConfiguration, updateProgress: suspend (progress: Progress) -> Unit = {})

Set DNS configuration

Link copied to clipboard
abstract suspend fun setDnsServer(dnsServerIp: IpAddress, updateProgress: suspend (progress: Progress) -> Unit = {})

Set DNS server IP address

Link copied to clipboard
abstract suspend fun setModemATLogState(isLogEnabled: Boolean, updateProgress: suspend (progress: Progress) -> Unit = {})

Enable/disable modem at commands log state

Link copied to clipboard
abstract suspend fun setModemControl(enableModem: Boolean, updateProgress: suspend (progress: Progress) -> Unit = {})

Enable/disable cellular modem. When disabled, the device will work as a regular Bluetooth sensor. Device will restart when modem control is changed.

Link copied to clipboard
abstract suspend fun setModemLogState(modemLogConfiguration: ModemLogConfiguration, updateProgress: suspend (progress: Progress) -> Unit = {})

Set modem log configuration

Link copied to clipboard
abstract suspend fun setNetworkTroubleshooting(isTroubleshootingEnabled: Boolean, updateProgress: suspend (progress: Progress) -> Unit = {})

Set network troubleshooting configuration

Link copied to clipboard
abstract suspend fun setServerCommunicationConfiguration(serverCommunicationConfiguration: ServerCommunicationConfiguration, updateProgress: suspend (progress: Progress) -> Unit = {})

Set server communication configuration

Link copied to clipboard
abstract suspend fun setServerConfiguration(serverConfiguration: ServerConfiguration, updateProgress: suspend (progress: Progress) -> Unit = {})

Set server configuration

Link copied to clipboard
abstract suspend fun setServerTransferLimit(transferLimitConfiguration: TransferLimitConfiguration, updateProgress: suspend (progress: Progress) -> Unit = {})

Request new transfer limit parameters (initial number of tokens and initial timer settings). Transfer limit determines the initial number of tokens. The token is needed to get a connection and sending measurements via the cellular network. The cost of each such transfer is one token. New token is added every period configured in the transfer limit timer (expressed in seconds).

Link copied to clipboard
abstract suspend fun setSupervisionPeriod(supervisionPeriod: Int, updateProgress: suspend (progress: Progress) -> Unit = {})

Set supervision period

Link copied to clipboard
abstract suspend fun triggerCommunicationWithServer(updateProgress: suspend (progress: Progress) -> Unit = {})

Trigger communication with the server over the cellular network

Generated by Dokka
© 2025 Copyright