ElWebApiClient class

A client to interact with ECHONET Lite Web API server v1

Authentications could be set via header object.

Constructors

ElWebApiClient({required String url, Client? client, Object? header})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

fetchRegisteredDevicesResources(RegisteredDeviceList? registeredDeviceList) → Future<List<EchonetLiteDevice>?>

Get all registered devices with detailed information directly from an abstracted list of registered devices

getAirCleaner(String deviceId) → Future<AirCleaner?>

getAirConditionerVentilationFan(String deviceId) → Future<AirConditionerVentilationFan?>

getBathHeatingStatusSensor(String deviceId) → Future<BathHeatingStatusSensor?>

getBathroomHeaterDryer(String deviceId) → Future<BathroomHeaterDryer?>

getCo2Sensor(String deviceId) → Future<Co2Sensor?>

getColdOrHotWaterHeatSourceEquipment(String deviceId) → Future<ColdOrHotWaterHeatSourceEquipment?>

getCommercialAirConditionerIndoorUnit(String deviceId) → Future<CommercialAirConditionerIndoorUnit?>

getCommercialAirConditionerOutdoorUnit(String deviceId) → Future<CommercialAirConditionerOutdoorUnit?>

getCommercialShowcase(String deviceId) → Future<CommercialShowcase?>

getCommercialShowcaseOutdoorUnit(String deviceId) → Future<CommercialShowcaseOutdoorUnit?>

getController(String deviceId) → Future<Controller?>

getCookingHeater(String deviceId) → Future<CookingHeater?>

getCurrentSensor(String deviceId) → Future<CurrentSensor?>

getDeviceResources(DeviceType deviceType, String id) → Future<EchonetLiteDevice?>

getDeviceResourcesByType(DeviceType type, RegisteredDeviceList? registeredDeviceList) → Future<List<EchonetLiteDevice>?>

getElectricCurtain(String deviceId) → Future<ElectricCurtain?>

getElectricEnergySensor(String deviceId) → Future<ElectricEnergySensor?>

getElectricLock(String deviceId) → Future<ElectricLock?>

getElectricRainDoor(String deviceId) → Future<ElectricRainDoor?>

getElectricShade(String deviceId) → Future<ElectricShade?>

getElectricWaterHeater(String deviceId) → Future<ElectricWaterHeater?>

getElectricWindow(String deviceId) → Future<ElectricWindow?>

getEmergencyButton(String deviceId) → Future<EmergencyButton?>

getEnhancedLightingSystem(String deviceId) → Future<EnhancedLightingSystem?>

getEvCharger(String deviceId) → Future<EvCharger?>

getEvChargerDischarger(String deviceId) → Future<EvChargerDischarger?>

getFloorHeater(String deviceId) → Future<FloorHeater?>

getFuelCell(String deviceId) → Future<FuelCell?>

getGasMeter(String deviceId) → Future<GasMeter?>

getGeneralLighting(String deviceId) → Future<GeneralLighting?>

getHomeAirConditioner(String deviceId) → Future<HomeAirConditioner?>

getHumanDetectionSensor(String deviceId) → Future<HumanDetectionSensor?>

getHumiditySensor(String deviceId) → Future<HumiditySensor?>

getHvSmartElectricEnergyMeter(String deviceId) → Future<HvSmartElectricEnergyMeter?>

getHybridWaterHeater(String deviceId) → Future<HybridWaterHeater?>

getIlluminanceSensor(String deviceId) → Future<IlluminanceSensor?>

getInstantaneousWaterHeater(String deviceId) → Future<InstantaneousWaterHeater?>

getLightingSystem(String deviceId) → Future<LightingSystem?>

getLvSmartElectricEnergyMeter(String deviceId) → Future<LvSmartElectricEnergyMeter?>

getMonoFunctionalLighting(String deviceId) → Future<MonoFunctionalLighting?>

getPowerDistributionBoardMetering(String deviceId) → Future<PowerDistributionBoardMetering?>

getPvPowerGeneration(String deviceId) → Future<PvPowerGeneration?>

getRefrigerator(String deviceId) → Future<Refrigerator?>

getRegisteredDevices() → Future<RegisteredDeviceList>

Get all registered devices

getRiceCooker(String deviceId) → Future<RiceCooker?>

getSmartElectricEnergySubMeter(String deviceId) → Future<SmartElectricEnergySubMeter?>

getStorageBattery(String deviceId) → Future<StorageBattery?>

getSwitch(String deviceId) → Future<Switch?>

getTemperatureSensor(String deviceId) → Future<TemperatureSensor?>

getTv(String deviceId) → Future<Tv?>

getVentilationFan(String deviceId) → Future<VentilationFan?>

getVocSensor(String deviceId) → Future<VocSensor?>

getWasherDryer(String deviceId) → Future<WasherDryer?>

getWaterFlowMeter(String deviceId) → Future<WaterFlowMeter?>

getWattHourMeter(String deviceId) → Future<WattHourMeter?>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setOperationStatus(String deviceId, bool status) → Future<bool>

setPropertyNameWithValue(String deviceId, String propertyName, dynamic value) → Future<bool>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited