Available sensors and actuators =============================== .. note:: This is an apendix with extended information useful for `adding a new sensor <../interface/sensor.html#add-sensor-to-a-gateway>`__. ADAM4055 -------------------------------------------- Managing an ADAM 4055 modbus device .. image:: ../assets/images/sensors/adam_4055_params.png ADXL345 -------------------------------------------- 3-axis accelerometer (13-bit) .. image:: ../assets/images/sensors/adxl345_params.png Tags updated by this sensor: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------------+-----------------------------------------------------------------------+ | Tag | Description | +==================================+=======================================================================+ | *SENSOR_ID*-x | Aceleration for X axis | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*-y | Aceleration for Y axis | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*-z | Aceleration for Z axis | +----------------------------------+-----------------------------------------------------------------------+ ADXL345 (Edison) -------------------------------------------- 3-axis accelerometer (13-bit) for edison Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/adxl345_edison_params.png BMF136 -------------------------------------------- Monitors up to 12 three phase circuits or 36 single phase circuits, or any combination of single or three phase circuits. .. image:: ../assets/images/sensors/bfm136_params.png BMF136 Data -------------------------------------------- Monitors up to 12 three phase circuits or 36 single phase circuits, or any combination of single or three phase circuits. Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/bfm136-data_params.png BME280 -------------------------------------------- Temperature, humidity and pressure sensor .. image:: ../assets/images/sensors/bme280_params.png Tags updated by this sensor: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------------+-----------------------------------------------------------------------+ | Tag | Description | +==================================+=======================================================================+ | *SENSOR_ID*-temp | Measured temperature | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*-press | Measured pressure | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*-hum | Measured humidity | +----------------------------------+-----------------------------------------------------------------------+ Carlo Gavazzi em21 -------------------------------------------- Three-phase energy meter. .. image:: ../assets/images/sensors/carloGavazzi_em21_params.png Tags updated by this sensor: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------------+-----------------------------------------------------------------------+ | Tag | Description | +==================================+=======================================================================+ | *SENSOR_ID*-v-l1 | Measured voltage on line 1 | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*-v-l2 | Measured voltage on line 2 | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*-v-l3 | Measured voltage on line 3 | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*-i-l1 | Measured current on line 1 | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*-i-l2 | Measured current on line 2 | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*-i-l3 | Measured current on line 3 | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*-watts | Total measured power | +----------------------------------+-----------------------------------------------------------------------+ CoAp sensor -------------------------------------------- Receives data from remote CoAp sensor CoAp actuator -------------------------------------------- Send values to a remote CoAp actuator .. image:: ../assets/images/sensors/coapActuator_params.png Core temp (Edison) -------------------------------------------- Read a CPU core temperature Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 Degrees to 100 Degrees * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/coretemp_edison_params.png Core temp (Galileo) -------------------------------------------- Read a CPU core temperature Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 Degrees to 100 Degrees * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/coretemp_galileo_params.png CPU free -------------------------------------------- Return the current amout of free CPU Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 % to 100 % * Reports to the broker every 10 seconds MCP4725 I2C DAC -------------------------------------------- MCP4725 I2C Digital to analog converter .. image:: ../assets/images/sensors/dac_params.png DISK free -------------------------------------------- Return the current amout of free DISK Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 % to 100 % * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/diskfree_params.png ESP3 receiver -------------------------------------------- EnOcean Serial Protocol 3 receiver (needed for using 'ESP3 input' and 'ESP3 node') .. image:: ../assets/images/sensors/esp3_params.png ESP3 input -------------------------------------------- Read the given index value for the specified ESP3 node * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/esp3-input_params.png ESP3 node -------------------------------------------- Declare an ESP3 node .. image:: ../assets/images/sensors/esp3-node_params.png SM6 Geophone -------------------------------------------- SM6 Omni-directional Geophone over I2C ADC Pi Plus .. image:: ../assets/images/sensors/geophone-sm6_params.png Tags updated by this sensor: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------------+-----------------------------------------------------------------------+ | Tag | Description | +==================================+=======================================================================+ | *SENSOR_ID*\_ppv\_x | Measured PPV on X axis | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*\_frequency\_x | Frequency associated with the measured PPV on X axis | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*\_ppv\_y | Measured PPV on Y axis | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*\_frequency\_y | Frequency associated with the measured PPV on Y axis | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*\_ppv\_z | Measured PPV on Z axis | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*\_frequency\_z | Frequency associated with the measured PPV on Z axis | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*\_ppv\_rms | Equivalent RMS vibration | +----------------------------------+-----------------------------------------------------------------------+ GPI -------------------------------------------- General Purpose Input * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/gpi_params.png GPI (Edison) -------------------------------------------- General Purpose Input for Edison * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/gpi_edison_params.png GPO -------------------------------------------- General Purpose Output .. image:: ../assets/images/sensors/gpo_params.png GPO (Edison) -------------------------------------------- General Purpose Output for Edison .. image:: ../assets/images/sensors/gpo_edison_params.png GPS Janus -------------------------------------------- Init the modem to use the GPS and get position fixes from the GPS. GPS Janus 3G -------------------------------------------- Init the modem to use the GPS and get position fixes from the GPS. Activate GPS for janus Home easy PIR 1 -------------------------------------------- Remote Control PIR Motion Detector Wall Switch * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/home-easy-pir1_params.png Home easy PIR 2 -------------------------------------------- Remote Control PIR Motion Detector Wall Switch * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/home-easy-pir2_params.png IIO ADC -------------------------------------------- Read voltage from ADC Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/iio-adc_params.png IIO ADC (Edison) -------------------------------------------- Read voltage from ADC for Edison Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/iio-adc_edison_params.png IIO ADC PiPlus -------------------------------------------- Read ADC values over I2C from a Pi Plus Hat Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/iio-adc_piplus_params.png IIO digital -------------------------------------------- Read digital input from especified IIO file * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/iio-dig_params.png Kankun plug -------------------------------------------- Drive a kankun plug switch Key barrel -------------------------------------------- * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/keybarrel_params.png LCD RGB UP -------------------------------------------- Drive an LCD with RGB backlight from Up Board .. image:: ../assets/images/sensors/lcd-rgb_up_params.png LED Supermicro -------------------------------------------- Drive Supermicro LED .. image:: ../assets/images/sensors/led_supermicro_params.png Light wave rf socket -------------------------------------------- .. image:: ../assets/images/sensors/lightwaverf_socket_params.png LM Sensor -------------------------------------------- Provides temperatures, voltage, and fans information. Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/lmsensor_params.png Local actuator -------------------------------------------- Local dummy actuator Local asynchronous sensor -------------------------------------------- Local dummy sensor that send value to cloud on every update * Reports to the broker every time a new value is readed Local sensor -------------------------------------------- Local dummy sensor Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds Memory free -------------------------------------------- Periodically calculate free system memory Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 % to 100 % * Reports to the broker every 10 seconds Network failover -------------------------------------------- Sets up different network metrics to ensure traffic goes through a main interface .. image:: ../assets/images/sensors/net_failover_params.png 1-Wire temperature -------------------------------------------- 1-Wire temperature sensor Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from -55 C to 125 C * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/onewiretemp_params.png Oregon rain -------------------------------------------- Oregon rain sensor * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/oregon-rain_params.png Oregon wind -------------------------------------------- Oregon wind sensor * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/oregon-wind_params.png Papouch TQS3 modbus -------------------------------------------- Mange Papouch TQS3 modbus device Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/papouch_TQS3_modbus_rs485_params.png Papouch TQS3 modbus TCP -------------------------------------------- Manage Papouch TQS3 modbus device Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/papouch_TQS3_modbus_tcp_params.png PWM (Edison) -------------------------------------------- PWM for Edison .. image:: ../assets/images/sensors/pwm_edison_params.png PWM (Supermicro) -------------------------------------------- PWM for Supermicro .. image:: ../assets/images/sensors/pwm_supermicro_params.png Rayleigh smart meter (ModBus RTU) -------------------------------------------- Manage Rayleigh smart meter (ModBus RTU) Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/rayleigh_smart_meter_modbus_rtu_params.png Rayleigh smart meter (ModBus TCP) -------------------------------------------- Manage Rayleigh smart meter (ModBus TCP) Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/rayleigh_smart_meter_modbus_tcp_params.png RFID -------------------------------------------- * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/rfid_params.png RFXCOM -------------------------------------------- Create an RF discovery sensor. This sensor listens for RF devices and sets a tag whenever any are found. .. image:: ../assets/images/sensors/rfxcom_params.png Serial 16x2 LCD display -------------------------------------------- Writes to a serial 16x2 LCD display. .. image:: ../assets/images/sensors/serLcd16x2_params.png Serial temperature sensor -------------------------------------------- Reads temperature form the temperature serial sensor. Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from -20 to 50 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/sertemp_params.png Sound level -------------------------------------------- Calculate sound level in dbA using a microphone .. image:: ../assets/images/sensors/sound_params.png Tags updated by this sensor: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +----------------------------------+-----------------------------------------------------------------------+ | Tag | Description | +==================================+=======================================================================+ | *SENSOR_ID*\_leq | Equivalent sound level measured during the last *Duration* seconds | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*\_lmin | Minimun sound level measured during the last *Duration* seconds | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*\_l90 | Sound level measured 90% of the last *Duration* seconds | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*\_l10 | Sound level measured 10% of the last *Duration* seconds | +----------------------------------+-----------------------------------------------------------------------+ | *SENSOR_ID*\_lmax | Minimun sound level measured during the last *Duration* seconds | +----------------------------------+-----------------------------------------------------------------------+ SSP cash acceptance -------------------------------------------- Enable/Disable `Sunset Pass `__ cash acceptance SSP cash accepted -------------------------------------------- `Sunset Pass `__ cash accepted sensor * Reports to the broker every time a new value is readed SSP cash acceptor status -------------------------------------------- `Sunset Pass `__ cash acceptor status sensor Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds SSP cash dispensed -------------------------------------------- `Sunset Pass `__ cash dispensed sensor * Reports to the broker every time a new value is readed SSP cash dispenser -------------------------------------------- `Sunset Pass `__ cash dispenser actuator SSP errors -------------------------------------------- `Sunset Pass `__ errors sensor * Reports to the broker every time a new value is readed SSP item dispensed -------------------------------------------- `Sunset Pass `__ item dispensed sensor * Reports to the broker every time a new value is readed SSP item dispenser -------------------------------------------- `Sunset Pass `__ item dispenser actuator SSP motor running -------------------------------------------- `Sunset Pass `__ motor running sensor Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds SSP status -------------------------------------------- `Sunset Pass `__ status sensor * Reports to the broker every time a new value is readed SunGrow Inverter (ModBus TCP) -------------------------------------------- Manage SunGrow Inverter (ModBus TCP) Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 0 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/sungrow_inverter_modbus_tcp_params.png THGR810 -------------------------------------------- Oregon Scientific Thermometer and Humidity Sensor-10 Channels * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/thgr810_params.png TOSR0X relay board -------------------------------------------- Set tosr04/tosr08 relays connected by serial link .. image:: ../assets/images/sensors/tosr04_tty_params.png TOSR0X relay board XBee -------------------------------------------- Set tosr04/tosr08 relays connected by XBee link .. image:: ../assets/images/sensors/tosr04_xbee_params.png VCNL4010 -------------------------------------------- Proximity/Light sensor Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 300 to 2500 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/vnl4000_params.png VCNL4010 (Edison) -------------------------------------------- Proximity/Light sensor for Edison Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from 300 to 2500 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/vnl4000_edison_params.png WiFi signal -------------------------------------------- WiFi signal sensor Default properties: ^^^^^^^^^^^^^^^^^^^ * Reads values from -100 to 100 * Reports to the broker every 10 seconds .. image:: ../assets/images/sensors/wifi-signal_params.png XBee -------------------------------------------- XBee .. image:: ../assets/images/sensors/xbee_params.png XBee ADC -------------------------------------------- XBee ADC sensor * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/xbee-adc_params.png XBee GPI -------------------------------------------- XBee General Purpose Input * Reports to the broker every time a new value is readed .. image:: ../assets/images/sensors/xbee-gpi_params.png XBee GPO -------------------------------------------- XBee General Purpose Output .. image:: ../assets/images/sensors/xbee-gpo_params.png XBee node -------------------------------------------- XBee node .. image:: ../assets/images/sensors/xbee-node_params.png