Cellular

public protocol Cellular : Peripheral

Cellular peripheral interface.

This peripheral allows using cellular feature.

This peripheral can be retrieved by:

device.getPeripheral(Peripherals.cellular)

  • Cellular mode setting.

    Declaration

    Swift

    var mode: CellularModeSetting { get }

  • SIM status.

    Declaration

    Swift

    var simStatus: CellularSimStatus { get }

  • SIM serial number.

    Declaration

    Swift

    var simIccid: String { get }

  • SIM International Mobile Subscriber Identity (imsi).

    Declaration

    Swift

    var simImsi: String { get }

  • Registration status

    Declaration

    Swift

    var registrationStatus: CellularRegistrationStatus { get }

  • Operator name.

    Declaration

    Swift

    var `operator`: String { get }

  • Technology

    Declaration

    Swift

    var technology: CellularTechnology { get }

  • Indicates if roaming is allowed or not

    Declaration

    Swift

    var isRoamingAllowed: BoolSetting { get }

  • Network mode

    Declaration

    Swift

    var networkMode: CellularNetworkModeSetting { get }

  • Modem status

    Declaration

    Swift

    var modemStatus: CellularModemStatus { get }

  • International mobile equipment identity (IMEI).

    Declaration

    Swift

    var imei: String { get }

  • Network status

    Declaration

    Swift

    var networkStatus: CellularNetworkStatus { get }

  • APN Configuration setting

    Declaration

    Swift

    var apnConfigurationSetting: ApnConfigurationSetting { get }

  • Whether PIN code is requested. true if PIN is requested, false otherwise.

    Declaration

    Swift

    var isPinCodeRequested: Bool { get }

  • Whether PIN code is invalid. false if no PIN code has been provided yet or if no PIN code is requested, true if an invalid PIN code has been rejected by the SIM.

    Declaration

    Swift

    var isPinCodeInvalid: Bool { get }

  • Remaining PIN code tries.

    Declaration

    Swift

    var pinRemainingTries: Int { get }

  • Enters the PIN code.

    Declaration

    Swift

    func enterPinCode(pincode: String) -> Bool

    Parameters

    pincode

    PIN to use to unlock SIM card

    Return Value

    true if the pincode has been sent, false otherwise

  • Resets the cellular configuration. All settings will be reset to their default values, PIN code will be cleared, and the product will reboot if it is not flying.

    Declaration

    Swift

    func resetSettings() -> Bool

    Return Value

    true if the command has been sent, false otherwise

  • Cellular reset state.

    Declaration

    Swift

    var resetState: CellularResetState { get }