Fork me on GitHub

Detectors


Overview

GasSensor can supply two models of gas sensor which are a standard CO2 sensor and a standard CO sensor.

Gas sensor can be used to detect the air quality in a room and prevent of asphyxiation.

Physical properties
Property name Constant name Value Default value Type Modifiable
carbonMonoxydeSensor.currentConcentration CARBON_MONOXYDE_SENSOR_CURRENT_CONCENTRATION [0.0-undefined] 0.0 Double No

There is no physical consideration for this type of device. Indeed, this device is used to return a physical value. In our case, we do not care about the way the sensor gives this value.

It is necessary to have the global variable named CO2Concentration in a room if you want to use the CarbonDioxydeSensor sensor without getting errors. Likewise, it is required to set the global variable named COConcentration in a room if you want to use the sensor CarbonMonoxydeSensor.

Methods
Interface: fr.liglab.adele.icasa.device.gazSensor.CarbonMonoxydeSensor
  • getSerialNumber(): Get the device ID
  • getCOConcentration(): Get the current gaz (CO) concentration of the sensor in µg/m^3
Full datasheet here
Overview

GasSensor can supply two models of gas sensor which are a standard CO2 sensor and a standard CO sensor.

Gas sensor can be used to detect the air quality in a room and prevent of asphyxiation.

Physical properties
Property name Constant name Value Default value Type Modifiable
carbonDioxydeSensor.currentConcentration CARBON_DIOXYDE_SENSOR_CURRENT_CONCENTRATION [0.0-undefined] 0.0 Double No

There is no physical consideration for this type of device. Indeed, this device is used to return a physical value. In our case, we do not care about the way the sensor gives this value.

It is necessary to have the global variable named CO2Concentration in a room if you want to use the CarbonDioxydeSensor sensor without getting errors. Likewise, it is required to set the global variable named COConcentration in a room if you want to use the sensor CarbonMonoxydeSensor.

Methods
Interface: fr.liglab.adele.icasa.device.gazSensor.CarbonDioxydeSensor
  • getSerialNumber(): Get the device ID
  • getCO2Concentration(): Get the current gaz (CO2) concentration of the sensor in µg/m^3
Full datasheet here
Overview

Photometer can supply only one model of photometer which is a standard photometer. The photometer returns the value of the current illuminance. This value is expressed as a double, in lux units.

Electro-optical properties
Property name Constant name Value Default value Type Modifiable
photometer.currentIlluminance PHOTOMETER_CURRENT_ILLUMINANCE current_illuminance [0.0-undefined] 0.0 Double No

There is no physical consideration for this type of device. Indeed, this device is used to return a physical value. In our case, we do not care about the way the sensor gives this value.

It is necessary to have the global variable named Illuminance in a room if you want to use the photometer sensor without getting errors.

Methods
Interface: fr.liglab.adele.icasa.device.light.Photometer
  • getSerialNumber(): Get the device ID
  • getIlluminance(): Get the current illuminance in lux
Full datasheet here
Overview

PresenceSensor can supply only one model of presence sensor switch which is a standard presence sensor. The presence sensor can be used to detect if someone is present in a room.

Device properties
Property name Constant name Value Default value Type Modifiable
presenceSensor.sensedPresence PRESENCE_SENSOR_SENSED_PRESENCE True/False False Boolean No

If the sensedPresence property is true then there is someone close to the sensor. On the contrary, if the sensedPresence is false, there is no one close to the sensor.

Methods
Interface: fr.liglab.adele.icasa.device.presence.PresenceSensor
  • getSerialNumber(): Get the device ID
  • getSensedPresence(): Get the current status of the switch:
    • switched On: true
    • switched Off: false
Full datasheet here
Overview

MotionSensor can supply only one model of motion detection which is a standard transformation of a movement, into a signal or event. The motion sensor can be used to detect if someone is moving in a room. We describe in section MotionSensor device Outline methods linked to this device.

Methods
Interface: fr.liglab.adele.icasa.device.motion.MotionSensor
  • getSerialNumber(): Get the device ID
  • addListener(DeviceListener listener): Subscribe to motion events

Hereafter we explain methods that can be useful for the user to retrieve motion detection events.

Methods
Interface: fr.liglab.adele.icasa.device.DeviceListener
  • deviceEvent(MotionSensor device, Object value): Event triggered when the motion sensor detects a movement:
    • device: the motion sensor object
    • value: always Boolean.TRUE
Full datasheet here
Overview

PowerSwitch can supply only one model of power switch which is a standard binary switch. The power switch can switch ON and OFF an equipment (i.e.: binaryLight).

Device properties
Property name Constant name Value Default value Type Modifiable
powerSwitch.currentStatus POWER_STATUS_CURRENT_STATUS True/False False Boolean No

If the currentStatus property is true then all equipment in a room will be switched on. On the contrary, if the currentStatus is false, all equipment will be turn off.

Methods
Interface: fr.liglab.adele.icasa.device.power.PowerSwitch
  • getSerialNumber(): Get the device ID
  • getStatus(): Get the current status of the switch:
    • switched On: true
    • switched Off: false
  • switchOn(): Set the power switch status ON:
    • switched On: true
  • switchOff(): Set the power switch status OFF:
    • switched Off: false
Full datasheet here
Overview

PushButton can supply only one model of push button which is a standard binary button (is pressed, or not.). The push button can be used to notify events, for example, to send an alarm.

Device properties
Property name Constant name Value Default value Type Modifiable
pushButton.pushAndHold PUSH_AND_HOLD True/False False Boolean No
Methods
Interface: fr.liglab.adele.icasa.device.button.PushButton
  • getSerialNumber(): Get the device ID
  • isPushed(): Get the current status of the button:
    • Pushed: true
    • Released: false
Full datasheet here
Overview

Thermometer can supply only one model of thermometer which is a standard thermometer. The thermometer can be used to have the current temperature in a room. The thermometer device returns a value in Kelvin degree for the temperature.

Device properties
Property name Constant name Value Default value Type Modifiable
thermometer.currentTemperature THERMOMETER_CURRENT_TEMPERATURE [0.0-undefined] 0.0 Double No

It is necessary to have the global variable named Temperature in a room if you want to use the Thermometer sensor without getting errors.

Methods
Interface: fr.liglab.adele.icasa.device.temperature.Thermometer
  • getSerialNumber(): Get the device ID
  • getTemperature(): Get the current temperature of the thermometer in Kelvin degree
Full datasheet here