PredefinedCharacteristic Class Reference


                    
                    
                    accessoryFlags(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func accessoryFlags(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Accessory Flags",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    active(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func active(
    _ value: Enums.Active = .active,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Active",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.Active>

Show on GitHub


                    
                    
                    activeIdentifier(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func activeIdentifier(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Active Identifier",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = 0,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    activityInterval(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func activityInterval(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Activity Interval",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    administratorOnlyAccess(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func administratorOnlyAccess(
    _ value: Bool = false,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Administrator Only Access",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool>

Show on GitHub


                    
                    
                    applicationMatchingIdentifier(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func applicationMatchingIdentifier(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Application Matching Identifier",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    assetUpdateReadiness(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func assetUpdateReadiness(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Asset Update Readiness",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    audioFeedback(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func audioFeedback(
    _ value: Bool = false,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Audio Feedback",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool>

Show on GitHub


                    
                    
                    batteryLevel(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func batteryLevel(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Battery Level",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = .percentage,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    brightness(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func brightness(
    _ value: Int = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Brightness",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = .percentage,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    carbonDioxideDetected(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func carbonDioxideDetected(
    _ value: Enums.CarbonDioxideDetected = .normal,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Carbon dioxide Detected",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.CarbonDioxideDetected>

Show on GitHub


                    
                    
                    carbonDioxideLevel(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func carbonDioxideLevel(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Carbon dioxide Level",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .ppm,
    maxLength: Int? = nil,
    maxValue: Double? = 100000,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    carbonDioxidePeakLevel(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func carbonDioxidePeakLevel(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Carbon dioxide Peak Level",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .ppm,
    maxLength: Int? = nil,
    maxValue: Double? = 100000,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    carbonMonoxideDetected(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func carbonMonoxideDetected(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Carbon monoxide Detected",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    carbonMonoxideLevel(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func carbonMonoxideLevel(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Carbon monoxide Level",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .ppm,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    carbonMonoxidePeakLevel(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func carbonMonoxidePeakLevel(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Carbon monoxide Peak Level",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .ppm,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    ccaEnergyDetectThreshold(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func ccaEnergyDetectThreshold(
    _ value: Int = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "CCA Energy Detect Threshold",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    ccaSignalDetectThreshold(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func ccaSignalDetectThreshold(
    _ value: Int = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "CCA Signal Detect Threshold",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    characteristicValueActiveTransitionCount(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func characteristicValueActiveTransitionCount(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Characteristic Value Active Transition Count",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    characteristicValueTransitionControl(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func characteristicValueTransitionControl(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read, .write],
    description: String? = "Characteristic Value Transition Control",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    chargingState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func chargingState(
    _ value: Enums.ChargingState = .notChargeable,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Charging State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 2,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.ChargingState>

Show on GitHub


                    
                    
                    closedCaptions(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func closedCaptions(
    _ value: Enums.ClosedCaptions = .enabled,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Closed Captions",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.ClosedCaptions>

Show on GitHub


                    
                    
                    colorTemperature(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func colorTemperature(
    _ value: Int = 140,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Color Temperature",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 500,
    minValue: Double? = 140,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    configuredName(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func configuredName(
    _ value: String = "",
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Configured Name",
    format: CharacteristicFormat? = .string,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<String>

Show on GitHub


                    
                    
                    contactSensorState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func contactSensorState(
    _ value: Enums.ContactSensorState = .detected,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Contact Sensor State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.ContactSensorState>

Show on GitHub


                    
                    
                    coolingThresholdTemperature(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func coolingThresholdTemperature(
    _ value: Float = 10,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Cooling Threshold Temperature",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .celsius,
    maxLength: Int? = nil,
    maxValue: Double? = 35,
    minValue: Double? = 10,
    minStep: Double? = 0.1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    cryptoHash(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func cryptoHash(
    _ value: Data? = nil,
    permissions: [CharacteristicPermission] = [.write],
    description: String? = "Crypto Hash",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data?>

Show on GitHub


                    
                    
                    currentAirPurifierState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentAirPurifierState(
    _ value: Enums.CurrentAirPurifierState = .inactive,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Air Purifier State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 2,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.CurrentAirPurifierState>

Show on GitHub


                    
                    
                    currentAirQuality(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentAirQuality(
    _ value: Enums.CurrentAirQuality = .good,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Air Quality",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 5,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.CurrentAirQuality>

Show on GitHub


                    
                    
                    currentDoorState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentDoorState(
    _ value: Enums.CurrentDoorState = .open,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Door State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 4,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.CurrentDoorState>

Show on GitHub


                    
                    
                    currentFanState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentFanState(
    _ value: Enums.CurrentFanState = .inactive,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Fan State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 2,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.CurrentFanState>

Show on GitHub


                    
                    
                    currentHeaterCoolerState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentHeaterCoolerState(
    _ value: Enums.CurrentHeaterCoolerState = .heating,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Heater-Cooler State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 3,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.CurrentHeaterCoolerState>

Show on GitHub


                    
                    
                    currentHeatingCoolingState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentHeatingCoolingState(
    _ value: Enums.CurrentHeatingCoolingState = .cool,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Heating Cooling State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 2,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.CurrentHeatingCoolingState>

Show on GitHub


                    
                    
                    currentHorizontalTiltAngle(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentHorizontalTiltAngle(
    _ value: Int = -90,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Horizontal Tilt Angle",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = .arcdegrees,
    maxLength: Int? = nil,
    maxValue: Double? = 90,
    minValue: Double? = -90,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    currentHumidifierDehumidifierState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentHumidifierDehumidifierState(
    _ value: Enums.CurrentHumidifierDehumidifierState = .inactive,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Humidifier-Dehumidifier State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 3,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.CurrentHumidifierDehumidifierState>

Show on GitHub


                    
                    
                    currentLightLevel(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentLightLevel(
    _ value: Float = 0.0001,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Light Level",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .lux,
    maxLength: Int? = nil,
    maxValue: Double? = 100000,
    minValue: Double? = 0.0001,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    currentMediaState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentMediaState(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Media State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 5,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    currentPosition(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentPosition(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Position",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = .percentage,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    currentRelativeHumidity(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentRelativeHumidity(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Relative Humidity",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .percentage,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    currentSlatState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentSlatState(
    _ value: Enums.CurrentSlatState = .inactive,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Slat State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 3,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.CurrentSlatState>

Show on GitHub


                    
                    
                    currentTemperature(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentTemperature(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Temperature",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .celsius,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 0.1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    currentTiltAngle(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentTiltAngle(
    _ value: Int = -90,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Tilt Angle",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = .arcdegrees,
    maxLength: Int? = nil,
    maxValue: Double? = 90,
    minValue: Double? = -90,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    currentTransport(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentTransport(
    _ value: Bool = false,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Current Transport",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool>

Show on GitHub


                    
                    
                    currentVerticalTiltAngle(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentVerticalTiltAngle(
    _ value: Int = -90,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Vertical Tilt Angle",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = .arcdegrees,
    maxLength: Int? = nil,
    maxValue: Double? = 90,
    minValue: Double? = -90,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    currentVisibilityState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentVisibilityState(
    _ value: Enums.CurrentVisibilityState = .shown,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Visibility State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 3,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.CurrentVisibilityState>

Show on GitHub


                    
                    
                    currentWaterLevel(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func currentWaterLevel(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Current Water Level",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .percentage,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    displayOrder(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func displayOrder(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Display Order",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    eventRetransmissionMaximum(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func eventRetransmissionMaximum(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Event Retransmission Maximum",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    eventTransmissionCounters(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func eventTransmissionCounters(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Event Transmission Counters",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    filterChangeIndication(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func filterChangeIndication(
    _ value: Enums.FilterChangeIndication = .noChange,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Filter Change indication",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.FilterChangeIndication>

Show on GitHub


                    
                    
                    filterLifeLevel(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func filterLifeLevel(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Filter Life Level",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    filterResetChangeIndication(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func filterResetChangeIndication(
    _ value: UInt8? = nil,
    permissions: [CharacteristicPermission] = [.write],
    description: String? = "Filter Reset Change Indication",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 1,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8?>

Show on GitHub


                    
                    
                    firmwareRevision(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func firmwareRevision(
    _ value: String = "",
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Firmware Revision",
    format: CharacteristicFormat? = .string,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<String>

Show on GitHub


                    
                    
                    firmwareUpdateReadiness(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func firmwareUpdateReadiness(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Firmware Update Readiness",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    firmwareUpdateStatus(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func firmwareUpdateStatus(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Firmware Update Status",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    hardwareFinish(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func hardwareFinish(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Hardware Finish",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    hardwareRevision(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func hardwareRevision(
    _ value: String = "",
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Hardware Revision",
    format: CharacteristicFormat? = .string,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<String>

Show on GitHub


                    
                    
                    heartBeat(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func heartBeat(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Heart Beat",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    heatingThresholdTemperature(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func heatingThresholdTemperature(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Heating Threshold Temperature",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .celsius,
    maxLength: Int? = nil,
    maxValue: Double? = 25,
    minValue: Double? = 0,
    minStep: Double? = 0.1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    holdPosition(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func holdPosition(
    _ value: Bool? = nil,
    permissions: [CharacteristicPermission] = [.write],
    description: String? = "Hold Position",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool?>

Show on GitHub


                    
                    
                    hue(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func hue(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Hue",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .arcdegrees,
    maxLength: Int? = nil,
    maxValue: Double? = 360,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    identifier(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func identifier(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Identifier",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = 0,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    identify(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func identify(
    _ value: Bool? = nil,
    permissions: [CharacteristicPermission] = [.write],
    description: String? = "Identify",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool?>

Show on GitHub


                    
                    
                    inUse(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func inUse(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "In Use",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    inputDeviceType(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func inputDeviceType(
    _ value: Enums.InputDeviceType = .audiosystem,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Input Device Type",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 6,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.InputDeviceType>

Show on GitHub


                    
                    
                    inputSourceType(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func inputSourceType(
    _ value: Enums.InputSourceType = .svideo,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Input Source Type",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 10,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.InputSourceType>

Show on GitHub


                    
                    
                    isConfigured(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func isConfigured(
    _ value: Enums.IsConfigured = .notconfigured,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Is Configured",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.IsConfigured>

Show on GitHub


                    
                    
                    labelIndex(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func labelIndex(
    _ value: UInt8 = 1,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Label Index",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 255,
    minValue: Double? = 1,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    labelNamespace(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func labelNamespace(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Label Namespace",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 4,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    leakDetected(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func leakDetected(
    _ value: Enums.LeakDetected = .leakNotDetected,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Leak Detected",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.LeakDetected>

Show on GitHub


                    
                    
                    lockControlPoint(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func lockControlPoint(
    _ value: Data? = nil,
    permissions: [CharacteristicPermission] = [.write],
    description: String? = "Lock Control Point",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data?>

Show on GitHub


                    
                    
                    lockCurrentState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func lockCurrentState(
    _ value: Enums.LockCurrentState = .unsecured,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Lock Current State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 3,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.LockCurrentState>

Show on GitHub


                    
                    
                    lockLastKnownAction(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func lockLastKnownAction(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Lock Last Known Action",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 8,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    lockManagementAutoSecurityTimeout(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func lockManagementAutoSecurityTimeout(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Lock Management Auto Security Timeout",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = .seconds,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    lockPhysicalControls(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func lockPhysicalControls(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Lock Physical Controls",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    lockTargetState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func lockTargetState(
    _ value: Enums.LockTargetState = .unsecured,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Lock Target State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.LockTargetState>

Show on GitHub


                    
                    
                    logs(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func logs(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Logs",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    macRetransmissionMaximum(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func macRetransmissionMaximum(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "MAC Retransmission Maximum",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    macTransmissionCounters(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func macTransmissionCounters(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "MAC Transmission Counters",
    format: CharacteristicFormat? = .data,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    manufacturer(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func manufacturer(
    _ value: String = "",
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Manufacturer",
    format: CharacteristicFormat? = .string,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<String>

Show on GitHub


                    
                    
                    maximumTransmitPower(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func maximumTransmitPower(
    _ value: Int = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Maximum Transmit Power",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    metricsBufferFullState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func metricsBufferFullState(
    _ value: Bool = false,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Metrics Buffer Full State",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool>

Show on GitHub


                    
                    
                    model(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func model(
    _ value: String = "",
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Model",
    format: CharacteristicFormat? = .string,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<String>

Show on GitHub


                    
                    
                    motionDetected(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func motionDetected(
    _ value: Bool = false,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Motion Detected",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool>

Show on GitHub


                    
                    
                    mute(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func mute(
    _ value: Bool = false,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Mute",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool>

Show on GitHub


                    
                    
                    name(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func name(
    _ value: String = "",
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Name",
    format: CharacteristicFormat? = .string,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<String>

Show on GitHub


                    
                    
                    nitrogenDioxideDensity(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func nitrogenDioxideDensity(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Nitrogen dioxide Density",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .microgramsPerMCubed,
    maxLength: Int? = nil,
    maxValue: Double? = 1000,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    obstructionDetected(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func obstructionDetected(
    _ value: Bool = false,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Obstruction Detected",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool>

Show on GitHub


                    
                    
                    occupancyDetected(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func occupancyDetected(
    _ value: Enums.OccupancyDetected = .occupancyDetected,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Occupancy Detected",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.OccupancyDetected>

Show on GitHub


                    
                    
                    operatingStateResponse(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func operatingStateResponse(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Operating State Response",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    outletInUse(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func outletInUse(
    _ value: Bool = false,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Outlet In Use",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool>

Show on GitHub


                    
                    
                    ozoneDensity(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func ozoneDensity(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Ozone Density",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .microgramsPerMCubed,
    maxLength: Int? = nil,
    maxValue: Double? = 1000,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    pictureMode(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func pictureMode(
    _ value: Enums.PictureMode = .game,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Picture Mode",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 13,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.PictureMode>

Show on GitHub


                    
                    
                    ping(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func ping(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Ping",
    format: CharacteristicFormat? = .data,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    pm10Density(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func pm10Density(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "PM10 Density",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .microgramsPerMCubed,
    maxLength: Int? = nil,
    maxValue: Double? = 1000,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    pm25Density(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func pm25Density(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "PM2.5 Density",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .microgramsPerMCubed,
    maxLength: Int? = nil,
    maxValue: Double? = 1000,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    positionState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func positionState(
    _ value: Enums.PositionState = .increasing,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Position State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 2,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.PositionState>

Show on GitHub


                    
                    
                    powerModeSelection(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func powerModeSelection(
    _ value: Enums.PowerModeSelection? = nil,
    permissions: [CharacteristicPermission] = [.write],
    description: String? = "Power Mode Selection",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.PowerModeSelection?>

Show on GitHub


                    
                    
                    powerState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func powerState(
    _ value: Bool = false,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Power State",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool>

Show on GitHub


                    
                    
                    productData(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func productData(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Product Data",
    format: CharacteristicFormat? = .data,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    programMode(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func programMode(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Program Mode",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 2,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    programmableSwitchEvent(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func programmableSwitchEvent(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Programmable Switch Event",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 2,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    programmableSwitchOutputState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func programmableSwitchOutputState(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Programmable Switch Output State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    receivedSignalStrengthIndication(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func receivedSignalStrengthIndication(
    _ value: Int = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Received Signal Strength Indication",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    receiverSensitivity(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func receiverSensitivity(
    _ value: Int = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Receiver Sensitivity",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    relativeHumidityDehumidifierThreshold(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func relativeHumidityDehumidifierThreshold(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Relative Humidity Dehumidifier Threshold",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .percentage,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    relativeHumidityHumidifierThreshold(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func relativeHumidityHumidifierThreshold(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Relative Humidity Humidifier Threshold",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .percentage,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    remainingDuration(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func remainingDuration(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Remaining Duration",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = .seconds,
    maxLength: Int? = nil,
    maxValue: Double? = 3600,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    remoteKey(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func remoteKey(
    _ value: Enums.RemoteKey? = nil,
    permissions: [CharacteristicPermission] = [.write],
    description: String? = "Remote Key",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 16,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.RemoteKey?>

Show on GitHub


                    
                    
                    rotationDirection(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func rotationDirection(
    _ value: Enums.RotationDirection = .counterclockwise,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Rotation Direction",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.RotationDirection>

Show on GitHub


                    
                    
                    rotationSpeed(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func rotationSpeed(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Rotation Speed",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    saturation(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func saturation(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Saturation",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .percentage,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    securitySystemAlarmType(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func securitySystemAlarmType(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Security System Alarm Type",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    securitySystemCurrentState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func securitySystemCurrentState(
    _ value: Enums.SecuritySystemCurrentState = .disarm,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Security System Current State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 4,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.SecuritySystemCurrentState>

Show on GitHub


                    
                    
                    securitySystemTargetState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func securitySystemTargetState(
    _ value: Enums.SecuritySystemTargetState = .disarm,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Security System Target State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 3,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.SecuritySystemTargetState>

Show on GitHub


                    
                    
                    selectedDiagnosticsModes(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func selectedDiagnosticsModes(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read, .write],
    description: String? = "Selected Diagnostics Modes",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    serialNumber(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func serialNumber(
    _ value: String = "",
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Serial Number",
    format: CharacteristicFormat? = .string,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<String>

Show on GitHub


                    
                    
                    setDuration(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func setDuration(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Set Duration",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = .seconds,
    maxLength: Int? = nil,
    maxValue: Double? = 3600,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    setupTransferTransport(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func setupTransferTransport(
    _ value: Data? = nil,
    permissions: [CharacteristicPermission] = [.write],
    description: String? = "Setup Transfer Transport",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data?>

Show on GitHub


                    
                    
                    signalToNoiseRatio(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func signalToNoiseRatio(
    _ value: Int = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Signal-to-noise Ratio",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    slatType(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func slatType(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Slat Type",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    sleepDiscoveryMode(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func sleepDiscoveryMode(
    _ value: Enums.SleepDiscoveryMode = .notdiscoverable,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Sleep Discovery Mode",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.SleepDiscoveryMode>

Show on GitHub


                    
                    
                    sleepInterval(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func sleepInterval(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Sleep Interval",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    smokeDetected(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func smokeDetected(
    _ value: Enums.SmokeDetected = .smokedetected,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Smoke Detected",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.SmokeDetected>

Show on GitHub


                    
                    
                    softwareRevision(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func softwareRevision(
    _ value: String = "",
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Software Revision",
    format: CharacteristicFormat? = .string,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<String>

Show on GitHub


                    
                    
                    stagedFirmwareVersion(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func stagedFirmwareVersion(
    _ value: String = "",
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Staged Firmware Version",
    format: CharacteristicFormat? = .string,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<String>

Show on GitHub


                    
                    
                    statusActive(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func statusActive(
    _ value: Bool = false,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Status Active",
    format: CharacteristicFormat? = .bool,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Bool>

Show on GitHub


                    
                    
                    statusFault(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func statusFault(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Status Fault",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    statusLowBattery(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func statusLowBattery(
    _ value: Enums.StatusLowBattery = .batteryNormal,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Status Low Battery",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.StatusLowBattery>

Show on GitHub


                    
                    
                    statusTampered(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func statusTampered(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Status Tampered",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    sulphurDioxideDensity(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func sulphurDioxideDensity(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Sulphur dioxide Density",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .microgramsPerMCubed,
    maxLength: Int? = nil,
    maxValue: Double? = 1000,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    supportedAssetTypes(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func supportedAssetTypes(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Supported Asset Types",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    supportedCharacteristicValueTransitionConfiguration(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func supportedCharacteristicValueTransitionConfiguration(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Supported Characteristic Value Transition Configuration",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    supportedDiagnosticsModes(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func supportedDiagnosticsModes(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Supported Diagnostics Modes",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    supportedDiagnosticsSnapshot(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func supportedDiagnosticsSnapshot(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Supported Diagnostics Snapshot",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    supportedFirmwareUpdateConfiguration(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func supportedFirmwareUpdateConfiguration(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Supported Firmware Update Configuration",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    supportedMetrics(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func supportedMetrics(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read, .write],
    description: String? = "Supported Metrics",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    supportedTransferTransportConfiguration(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func supportedTransferTransportConfiguration(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Supported Transfer Transport Configuration",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub


                    
                    
                    swingMode(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func swingMode(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Swing Mode",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    tapType(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func tapType(
    _ value: UInt16 = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Tap Type",
    format: CharacteristicFormat? = .uint16,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt16>

Show on GitHub


                    
                    
                    targetAirPurifierState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetAirPurifierState(
    _ value: Enums.TargetAirPurifierState = .auto,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Air Purifier State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.TargetAirPurifierState>

Show on GitHub


                    
                    
                    targetDoorState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetDoorState(
    _ value: Enums.TargetDoorState = .open,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Door State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.TargetDoorState>

Show on GitHub


                    
                    
                    targetFanState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetFanState(
    _ value: Enums.TargetFanState = .auto,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Fan State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.TargetFanState>

Show on GitHub


                    
                    
                    targetHeaterCoolerState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetHeaterCoolerState(
    _ value: Enums.TargetHeaterCoolerState = .auto,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Heater-Cooler State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 2,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.TargetHeaterCoolerState>

Show on GitHub


                    
                    
                    targetHeatingCoolingState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetHeatingCoolingState(
    _ value: Enums.TargetHeatingCoolingState = .cool,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Heating Cooling State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 3,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.TargetHeatingCoolingState>

Show on GitHub


                    
                    
                    targetHorizontalTiltAngle(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetHorizontalTiltAngle(
    _ value: Int = -90,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Horizontal Tilt Angle",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = .arcdegrees,
    maxLength: Int? = nil,
    maxValue: Double? = 90,
    minValue: Double? = -90,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    targetHumidifierDehumidifierState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetHumidifierDehumidifierState(
    _ value: Enums.TargetHumidifierDehumidifierState = .auto,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Humidifier-Dehumidifier State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 2,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.TargetHumidifierDehumidifierState>

Show on GitHub


                    
                    
                    targetMediaState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetMediaState(
    _ value: Enums.TargetMediaState = .pause,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Media State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 2,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.TargetMediaState>

Show on GitHub


                    
                    
                    targetPosition(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetPosition(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Position",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = .percentage,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    targetRelativeHumidity(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetRelativeHumidity(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Relative Humidity",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .percentage,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    targetTemperature(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetTemperature(
    _ value: Float = 10,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Temperature",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .celsius,
    maxLength: Int? = nil,
    maxValue: Double? = 38,
    minValue: Double? = 10,
    minStep: Double? = 0.1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    targetTiltAngle(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetTiltAngle(
    _ value: Int = -90,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Tilt Angle",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = .arcdegrees,
    maxLength: Int? = nil,
    maxValue: Double? = 90,
    minValue: Double? = -90,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    targetVerticalTiltAngle(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetVerticalTiltAngle(
    _ value: Int = -90,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Vertical Tilt Angle",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = .arcdegrees,
    maxLength: Int? = nil,
    maxValue: Double? = 90,
    minValue: Double? = -90,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    targetVisibilityState(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func targetVisibilityState(
    _ value: Enums.TargetVisibilityState = .shown,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Target Visibility State",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.TargetVisibilityState>

Show on GitHub


                    
                    
                    temperatureDisplayUnits(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func temperatureDisplayUnits(
    _ value: Enums.TemperatureDisplayUnits = .celcius,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Temperature Display Units",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.TemperatureDisplayUnits>

Show on GitHub


                    
                    
                    threadControlPoint(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func threadControlPoint(
    _ value: Data? = nil,
    permissions: [CharacteristicPermission] = [.write],
    description: String? = "Thread Control Point",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data?>

Show on GitHub


                    
                    
                    threadNodeCapabilities(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func threadNodeCapabilities(
    _ value: UInt16 = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Thread Node Capabilities",
    format: CharacteristicFormat? = .uint16,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 31,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt16>

Show on GitHub


                    
                    
                    threadOpenthreadVersion(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func threadOpenthreadVersion(
    _ value: String = "",
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Thread OpenThread Version",
    format: CharacteristicFormat? = .string,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<String>

Show on GitHub


                    
                    
                    threadStatus(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func threadStatus(
    _ value: UInt16 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Thread Status",
    format: CharacteristicFormat? = .uint16,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 6,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt16>

Show on GitHub


                    
                    
                    token(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func token(
    _ value: Data? = nil,
    permissions: [CharacteristicPermission] = [.write],
    description: String? = "Token",
    format: CharacteristicFormat? = .data,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data?>

Show on GitHub


                    
                    
                    transmitPower(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func transmitPower(
    _ value: Int = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Transmit Power",
    format: CharacteristicFormat? = .int,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Int>

Show on GitHub


                    
                    
                    valveType(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func valveType(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Valve Type",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 3,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    version(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func version(
    _ value: String = "",
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Version",
    format: CharacteristicFormat? = .string,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<String>

Show on GitHub


                    
                    
                    volatileOrganicCompoundDensity(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func volatileOrganicCompoundDensity(
    _ value: Float = 0,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Volatile Organic Compound Density",
    format: CharacteristicFormat? = .float,
    unit: CharacteristicUnit? = .microgramsPerMCubed,
    maxLength: Int? = nil,
    maxValue: Double? = 1000,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Float>

Show on GitHub


                    
                    
                    volume(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func volume(
    _ value: UInt8 = 0,
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Volume",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = .percentage,
    maxLength: Int? = nil,
    maxValue: Double? = 100,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt8>

Show on GitHub


                    
                    
                    volumeControlType(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func volumeControlType(
    _ value: Enums.VolumeControlType = .relativewithcurrent,
    permissions: [CharacteristicPermission] = [.read, .events],
    description: String? = "Volume Control Type",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 3,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.VolumeControlType>

Show on GitHub


                    
                    
                    volumeSelector(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func volumeSelector(
    _ value: Enums.VolumeSelector? = nil,
    permissions: [CharacteristicPermission] = [.write],
    description: String? = "Volume Selector",
    format: CharacteristicFormat? = .uint8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = 1,
    minValue: Double? = 0,
    minStep: Double? = 1,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Enums.VolumeSelector?>

Show on GitHub


                    
                    
                    wiFiCapabilities(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func wiFiCapabilities(
    _ value: UInt32 = 0,
    permissions: [CharacteristicPermission] = [.read],
    description: String? = "Wi-Fi Capabilities",
    format: CharacteristicFormat? = .uint32,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<UInt32>

Show on GitHub


                    
                    
                    wiFiConfigurationControl(_:permissions:description:format:unit:maxLength:maxValue:minValue:minStep:validValues:validValuesRange:)

Undocumented

Declaration

Swift

static func wiFiConfigurationControl(
    _ value: Data = Data(),
    permissions: [CharacteristicPermission] = [.read, .write, .events],
    description: String? = "Wi-Fi Configuration Control",
    format: CharacteristicFormat? = .tlv8,
    unit: CharacteristicUnit? = nil,
    maxLength: Int? = nil,
    maxValue: Double? = nil,
    minValue: Double? = nil,
    minStep: Double? = nil,
    validValues: [Double] = [],
    validValuesRange: Range<Double>? = nil
) -> GenericCharacteristic<Data>

Show on GitHub