CGA_Bluetooth_Characteristic_Protocol

public protocol CGA_Bluetooth_Characteristic_Protocol : AnyObject, RVS_SequenceProtocol

This protocol publishes a public interface for our Characteristic wrapper classes.

  • id

    This returns a unique UUID String for the instance.

    Declaration

    Swift

    var id: String { get }

  • If the Characteristic has a value, it is returned here. It is a standard Data type.

    Declaration

    Swift

    var value: Data? { get }

  • This holds the instance of CBDescriptor that is used by this instance.

    Declaration

    Swift

    var cbElementInstance: CBCharacteristic? { get }

  • This casts the parent as a Service Wrapper.

    Declaration

    Swift

    var service: CGA_Bluetooth_Service? { get }

  • Returns true, if the Characteristic can write (eithe with or without response).

    Declaration

    Swift

    var canWrite: Bool { get }

  • Returns true, if the Characteristic can write, and returns a receipt response.

    Declaration

    Swift

    var canWriteWithResponse: Bool { get }

  • Returns true, if the Characteristic can write, and does not return a response.

    Declaration

    Swift

    var canWriteWithoutResponse: Bool { get }

  • Returns true, if the Characteristic can be read.

    Declaration

    Swift

    var canRead: Bool { get }

  • Returns true, if the Characteristic can notify.

    Declaration

    Swift

    var canNotify: Bool { get }

  • Returns true, if the Characteristic can broadcast.

    Declaration

    Swift

    var canBroadcast: Bool { get }

  • Returns true, if the Characteristic can indicate.

    Declaration

    Swift

    var canIndicate: Bool { get }

  • Returns true, if the Characteristic is currently notifying.

    Declaration

    Swift

    var isNotifying: Bool { get }

  • Returns the maximum number of bytes that can be written for this Peripheral.

    Declaration

    Swift

    var maximumWriteLength: Int { get }

  • Returns true, if the Characteristic requires authenticated writes.

    Declaration

    Swift

    var requiresAuthenticatedSignedWrites: Bool { get }

  • Returns true, if the Characteristic requires encrypted notification.

    Declaration

    Swift

    var requiresNotifyEncryption: Bool { get }

  • Returns true, if the Characteristic requires encrypted indicates.

    Declaration

    Swift

    var requiresIndicateEncryption: Bool { get }

  • Returns true, if the Characteristic has extension properties.

    Declaration

    Swift

    var hasExtendedProperties: Bool { get }

  • This will return any extension properties, as a simple tuple, or nil, if there are none.

    Declaration

    Swift

    var extendedProperties: (isReliableWriteEnabled: Bool, isWritableAuxiliariesEnabled: Bool)? { get }

  • The Peripheral is asked to read the value.

    Declaration

    Swift

    func readValue()