Supported Inputs
- Deutsche: Deze pagina is niet vertaald naar het Duits.
- Español: Esta página no está traducida al castellano.
- Français: Cette page n'est pas traduite en français.
- Bahasa Indonesia: Halaman ini tidak diterjemahkan ke bahasa Indonesia.
- Italiano: Questa pagina non è tradotta in italiano.
- Norsk: Denne siden er ikke oversatt til norsk.
- Polski: Ta strona nie jest przetłumaczona na język polski.
- Português: Esta página não está traduzida para o português.
- русский язык: Эта страница не переведена на русский язык.
- српски: Ова страница није преведена на српски.
- Svenska: Denna sida är inte översatt till svenska.
- Türkçe: Bu sayfa Türkçe'ye çevrilmemiştir.
- 中文: 此页面未翻译成中文.
Linux: Bash Command
- Manufacturer: Linux
- Measurements: Return Value
- Interfaces: Mycodo
This Input will execute a command in the shell and store the output as a float value. Perform any unit conversions within your script or command. A measurement/unit is required to be selected.
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Command Timeout | Integer - Default Value: 60 | How long to wait for the command to finish before killing the process. |
User | Text - Default Value: mycodo | The user to execute the command |
Current Working Directory | Text - Default Value: /home/pi | The current working directory of the shell environment. |
Linux: Python 3 Code (v1.0)
- Manufacturer: Linux
- Measurements: Store Value(s)
- Interfaces: Mycodo
- Dependencies: pylint
All channels require a Measurement Unit to be selected and saved in order to store values to the database. Your code is executed from the same Python virtual environment that Mycodo runs from. Therefore, you must install Python libraries to this environment if you want them to be available to your code. This virtualenv is located at /opt/Mycodo/env and if you wanted to install a library, for example "my_library" using pip, you would execute "sudo /opt/Mycodo/env/bin/pip install my_library".
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Analyze Python Code with Pylint | Boolean - Default Value: True | Analyze your Python code with pylint when saving |
Linux: Python 3 Code (v2.0)
- Manufacturer: Linux
- Measurements: Store Value(s)
- Interfaces: Mycodo
- Dependencies: pylint
This is an alternate Python 3 Code Input that uses a different method for storing values to the database. This was created because the Python 3 Code v1.0 Input does not allow the use of Input Actions. This method does allow the use of Input Actions. (11/21/2023 Update: The Python 3 Code (v1.0) Input now allows the execution of Actions). All channels require a Measurement Unit to be selected and saved in order to store values to the database. Your code is executed from the same Python virtual environment that Mycodo runs from. Therefore, you must install Python libraries to this environment if you want them to be available to your code. This virtualenv is located at /opt/Mycodo/env and if you wanted to install a library, for example "my_library" using pip, you would execute "sudo /opt/Mycodo/env/bin/pip install my_library".
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Python 3 Code | The code to execute. Must return a value. |
Analyze Python Code with Pylint | Boolean - Default Value: True | Analyze your Python code with pylint when saving |
Mycodo: CPU Load
- Manufacturer: Mycodo
- Measurements: CPULoad
- Libraries: os.getloadavg()
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Mycodo: Free Space
- Manufacturer: Mycodo
- Measurements: Unallocated Disk Space
- Libraries: os.statvfs()
Period (Seconds) | Decimal | The duration between measurements or actions |
Mycodo: Mycodo Version
- Manufacturer: Mycodo
- Measurements: Version as Major.Minor.Revision
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Mycodo: Output State (On/Off)
- Manufacturer: Mycodo
- Measurements: Boolean
This Input stores a 0 (off) or 1 (on) for the selected On/Off Output.
Period (Seconds) | Decimal | The duration between measurements or actions |
On/Off Output Channel | Select Channel (Output_Channels) | Select an output to measure |
Mycodo: Server Ping
- Manufacturer: Mycodo
- Measurements: Boolean
- Libraries: ping
This Input executes the bash command "ping -c [times] -w [deadline] [host]" to determine if the host can be pinged.
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Mycodo: Server Port Open
- Manufacturer: Mycodo
- Measurements: Boolean
- Libraries: nc
This Input executes the bash command "nc -zv [host] [port]" to determine if the host at a particular port is accessible.
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Mycodo: Spacer
A spacer to organize Inputs.
Color | Text - Default Value: #000000 | The color of the name text |
Mycodo: System and Mycodo RAM
- Manufacturer: Mycodo
- Measurements: RAM Allocation
- Libraries: psutil, resource.getrusage()
- Dependencies: psutil
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Mycodo Frontend RAM Endpoint | Text - Default Value: https://127.0.0.1/ram | The endpoint to get Mycodo frontend ram usage |
- Manufacturer: Mycodo
- Measurements: Variable measurements
This is a simple test Input that allows you to save any value as a measurement, that will be stored in the measurement database. It can be useful for testing other parts of Mycodo, such as PIDs, Bang-Bang, and Conditional Functions, since you can be completely in control of what values the input provides to the Functions. Note 1: Select and save the Name and Measurement Unit for each channel. Once the unit has been saved, you can convert to other units in the Convert Measurement section. Note 2: Activate the Input before storing measurements.
Measurements Enabled | Multi-Select | The measurements to record |
Channel Options |
Name | Text | A name to distinguish this from others |
Commands |
Enter the Value you want to store as a measurement, then press Store Measurement. |
Channel | Integer | This is the channel to save the measurement value to |
Value | Decimal - Default Value: 10.0 | This is the measurement value to save for this Input |
Store Measurement | Button | |
Mycodo: Uptime
- Manufacturer: Mycodo
- Measurements: Seconds Since System Startup
Period (Seconds) | Decimal | The duration between measurements or actions |
Raspberry Pi: CPU/GPU Temperature
- Manufacturer: Raspberry Pi
- Measurements: Temperature
- Interfaces: RPi
The internal CPU and GPU temperature of the Raspberry Pi.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Path for CPU Temperature | Text - Default Value: /sys/class/thermal/thermal_zone0/temp | Reads the CPU temperature from this file |
Path to vcgencmd | Text - Default Value: /usr/bin/vcgencmd | Reads the GPU from vcgencmd |
Raspberry Pi: Edge Detection
- Manufacturer: Raspberry Pi
- Measurements: Rising/Falling Edge
- Interfaces: GPIO
- Libraries: RPi.GPIO
- Dependencies: RPi.GPIO
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Pin Mode | Select(Options: [Floating | Pull Down | Pull Up] (Default in bold) | Enables or disables the pull-up or pull-down resistor |
Raspberry Pi: GPIO State
- Manufacturer: Raspberry Pi
- Measurements: GPIO State
- Interfaces: GPIO
- Libraries: RPi.GPIO
- Dependencies: RPi.GPIO
Measures the state of a GPIO pin, returning either 0 (low) or 1 (high).
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Pin Mode | Select(Options: [Floating | Pull Down | Pull Up] (Default in bold) | Enables or disables the pull-up or pull-down resistor |
Raspberry Pi: Signal (PWM)
- Manufacturer: Raspberry Pi
- Measurements: Frequency/Pulse Width/Duty Cycle
- Interfaces: GPIO
- Libraries: pigpio
- Dependencies: pigpio, pigpio
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Raspberry Pi: Signal (Revolutions) (pigpio method #1)
- Manufacturer: Raspberry Pi
- Measurements: RPM
- Interfaces: GPIO
- Libraries: pigpio
- Dependencies: pigpio, pigpio
This calculates RPM from pulses on a pin using pigpio, but has been found to be less accurate than the method #2 module. This is typically used to measure the speed of a fan from a tachometer pin, however this can be used to measure any 3.3-volt pulses from a wire. Use a resistor to pull the measurement pin to 3.3 volts, set pigpio to the lowest latency (1 ms) on the Configure -> Raspberry Pi page. Note 1: Not setting pigpio to the lowest latency will hinder accuracy. Note 2: accuracy decreases as RPM increases.
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Raspberry Pi: Signal (Revolutions) (pigpio method #2)
- Manufacturer: Raspberry Pi
- Measurements: RPM
- Interfaces: GPIO
- Libraries: pigpio
- Dependencies: pigpio, pigpio
This is an alternate method to calculate RPM from pulses on a pin using pigpio, and has been found to be more accurate than the method #1 module. This is typically used to measure the speed of a fan from a tachometer pin, however this can be used to measure any 3.3-volt pulses from a wire. Use a resistor to pull the measurement pin to 3.3 volts, set pigpio to the lowest latency (1 ms) on the Configure -> Raspberry Pi page. Note 1: Not setting pigpio to the lowest latency will hinder accuracy. Note 2: accuracy decreases as RPM increases.
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Pin: GPIO (BCM) | Integer | The pin to measure pulses from |
Sample Time (Seconds) | Decimal - Default Value: 5.0 | The duration of time to sample |
Pulses Per Rev | Decimal - Default Value: 15.8 | The number of pulses per revolution to calculate revolutions per minute (RPM) |
AMS: AS7262
- Manufacturer: AMS
- Measurements: Light at 450, 500, 550, 570, 600, 650 nm
- Interfaces: I2C
- Libraries: as7262
- Dependencies: as7262
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Gain | Select(Options: [1x | 3.7x | 16x | 64x] (Default in bold) | Set the sensor gain |
Illumination LED Current | Select(Options: [12.5 mA | 25 mA | 50 mA | 100 mA] (Default in bold) | Set the illumination LED current (milliamps) |
Illumination LED Mode | Select(Options: [On | Off] (Default in bold) | Turn the illumination LED on or off during a measurement |
Indicator LED Current | Select(Options: [1 mA | 2 mA | 4 mA | 8 mA] (Default in bold) | Set the indicator LED current (milliamps) |
Indicator LED Mode | Select(Options: [On | Off] (Default in bold) | Turn the indicator LED on or off during a measurement |
Integration Time | Decimal - Default Value: 15.0 | The integration time (0 - ~91 ms) |
AMS: CCS811 (with Temperature)
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
AMS: CCS811 (without Temperature)
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
AMS: TSL2561
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
AMS: TSL2591
- Manufacturer: AMS
- Measurements: Light
- Interfaces: I2C
- Libraries: maxlklaxl/python-tsl2591
- Dependencies: tsl2591
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
AOSONG: AM2315/AM2320
- Manufacturer: AOSONG
- Measurements: Humidity/Temperature
- Interfaces: I2C
- Libraries: quick2wire-api
- Dependencies: quick2wire-api
- Datasheet URL: Link
- Product URL: Link
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
AOSONG: DHT11
- Manufacturer: AOSONG
- Measurements: Humidity/Temperature
- Interfaces: GPIO
- Libraries: pigpio
- Dependencies: pigpio, pigpio
- Datasheet URL: Link
- Product URL: Link
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
AOSONG: DHT20
- Manufacturer: AOSONG
- Measurements: Humidity/Temperature
- Interfaces: I2C
- Libraries: smbus2
- Dependencies: smbus2
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URLs: Link 1, Link 2, Link 3
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
AOSONG: DHT22
- Manufacturer: AOSONG
- Measurements: Humidity/Temperature
- Interfaces: GPIO
- Libraries: pigpio
- Dependencies: pigpio, pigpio
- Datasheet URL: Link
- Product URL: Link
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
ASAIR: AHTx0
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Adafruit: I2C Capacitive Moisture Sensor
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Analog Devices: ADT7410
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Analog Devices: ADXL34x (343, 344, 345, 346)
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Range | Select(Options: [±2 g (±19.6 m/s/s) | ±4 g (±39.2 m/s/s) | ±8 g (±78.4 m/s/s) | ±16 g (±156.9 m/s/s)] (Default in bold) | Set the measurement range |
AnyLeaf: AnyLeaf EC
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Conductivity Constant | Decimal - Default Value: 1.0 | Conductivity constant K |
AnyLeaf: AnyLeaf ORP
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Period (Seconds) | Decimal | The duration between measurements or actions |
Calibrate: Voltage (Internal) | Decimal - Default Value: 0.4 | Calibration data: internal voltage |
Calibrate: ORP (Internal) | Decimal - Default Value: 400.0 | Calibration data: internal ORP |
Commands |
Calibrate: Buffer ORP (mV) | Decimal - Default Value: 400.0 | This is the nominal ORP of the calibration buffer in mV, usually labelled on the bottle. |
Calibrate | Button | |
Clear Calibration Slots | Button | |
AnyLeaf: AnyLeaf pH
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Period (Seconds) | Decimal | The duration between measurements or actions |
Temperature Compensation: Measurement | Select Measurement (Input, Function) | Select a measurement for temperature compensation |
Temperature Compensation: Max Age (Seconds) | Integer - Default Value: 120 | The maximum age of the measurement to use |
Cal data: V1 (internal) | Decimal | Calibration data: Voltage |
Cal data: pH1 (internal) | Decimal - Default Value: 7.0 | Calibration data: pH |
Cal data: T1 (internal) | Decimal - Default Value: 23.0 | Calibration data: Temperature |
Cal data: V2 (internal) | Decimal - Default Value: 0.17 | Calibration data: Voltage |
Cal data: pH2 (internal) | Decimal - Default Value: 4.0 | Calibration data: pH |
Cal data: T2 (internal) | Decimal - Default Value: 23.0 | Calibration data: Temperature |
Cal data: V3 (internal) | Decimal | Calibration data: Voltage |
Cal data: pH3 (internal) | Decimal | Calibration data: pH |
Cal data: T3 (internal) | Decimal | Calibration data: Temperature |
Commands |
Calibration buffer pH | Decimal - Default Value: 7.0 | This is the nominal pH of the calibration buffer, usually labelled on the bottle. |
Calibrate, slot 1 | Button | |
Calibrate, slot 2 | Button | |
Calibrate, slot 3 | Button | |
Clear Calibration Slots | Button | |
Atlas Scientific: Atlas CO2 (Carbon Dioxide Gas)
- Manufacturer: Atlas Scientific
- Measurements: CO2
- Interfaces: I2C, UART, FTDI
- Libraries: pylibftdi/fcntl/io/serial
- Dependencies: pylibftdi
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
FTDI Device | Text | The FTDI device connected to the input/output/etc. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Commands |
A one- or two-point calibration can be performed. After exposing the probe to a concentration of CO2 between 3,000 and 5,000 ppmv until readings stabilize, press Calibrate (High). You can place the probe in a 0 CO2 environment until readings stabilize, then press Calibrate (Zero). You can also clear the currently-saved calibration by pressing Clear Calibration, returning to the factory-set calibration. Status messages will be sent to the Daemon Log, accessible from Config -> Mycodo Logs -> Daemon Log. |
High Point CO2 | Integer - Default Value: 3000 | The high CO2 calibration point (3000 - 5000 ppmv) |
Calibrate (High) | Button | |
Calibrate (Zero) | Button | |
Clear Calibration | Button | |
The I2C address can be changed. Enter a new address in the 0xYY format (e.g. 0x22, 0x50), then press Set I2C Address. Remember to deactivate and change the I2C address option after setting the new address. |
New I2C Address | Text - Default Value: 0x69 | The new I2C to set the device to |
Set I2C Address | Button | |
Atlas Scientific: Atlas Color
- Manufacturer: Atlas Scientific
- Measurements: RGB, CIE, LUX, Proximity
- Interfaces: I2C, UART, FTDI
- Libraries: pylibftdi/fcntl/io/serial
- Dependencies: pylibftdi
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
FTDI Device | Text | The FTDI device connected to the input/output/etc. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
LED Only For Measure | Boolean - Default Value: True | Turn the LED on only during the measurement |
LED Percentage | Integer - Default Value: 30 | What percentage of power to supply to the LEDs during measurement |
Gamma Correction | Decimal - Default Value: 1.0 | Gamma correction between 0.01 and 4.99 (default is 1.0) |
Commands |
The EZO-RGB color sensor is designed to be calibrated to a white object at the maximum brightness the object will be viewed under. In order to get the best results, Atlas Scientific strongly recommends that the sensor is mounted into a fixed location. Holding the sensor in your hand during calibration will decrease performance. 1. Embed the EZO-RGB color sensor into its intended use location. 2. Set LED brightness to the desired level. 3. Place a white object in front of the target object and press the Calibration button. 4. A single color reading will be taken and the device will be fully calibrated. |
Calibrate | Button | |
The I2C address can be changed. Enter a new address in the 0xYY format (e.g. 0x22, 0x50), then press Set I2C Address. Remember to deactivate and change the I2C address option after setting the new address. |
New I2C Address | Text - Default Value: 0x70 | The new I2C to set the device to |
Set I2C Address | Button | |
Atlas Scientific: Atlas DO
- Manufacturer: Atlas Scientific
- Measurements: Dissolved Oxygen
- Interfaces: I2C, UART, FTDI
- Libraries: pylibftdi/fcntl/io/serial
- Dependencies: pylibftdi
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
FTDI Device | Text | The FTDI device connected to the input/output/etc. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Temperature Compensation: Measurement | Select Measurement (Input, Function) | Select a measurement for temperature compensation |
Temperature Compensation: Max Age (Seconds) | Integer - Default Value: 120 | The maximum age of the measurement to use |
Commands |
A one- or two-point calibration can be performed. After exposing the probe to air for 30 seconds until readings stabilize, press Calibrate (Air). If you require accuracy below 1.0 mg/L, you can place the probe in a 0 mg/L solution for 30 to 90 seconds until readings stabilize, then press Calibrate (0 mg/L). You can also clear the currently-saved calibration by pressing Clear Calibration. Status messages will be sent to the Daemon Log, accessible from Config -> Mycodo Logs -> Daemon Log. |
Calibrate (Air) | Button | |
Calibrate (0 mg/L) | Button | |
Clear Calibration | Button | |
The I2C address can be changed. Enter a new address in the 0xYY format (e.g. 0x22, 0x50), then press Set I2C Address. Remember to deactivate and change the I2C address option after setting the new address. |
New I2C Address | Text - Default Value: 0x66 | The new I2C to set the device to |
Set I2C Address | Button | |
Atlas Scientific: Atlas EC
- Manufacturer: Atlas Scientific
- Measurements: Electrical Conductivity
- Interfaces: I2C, UART, FTDI
- Libraries: pylibftdi/fcntl/io/serial
- Dependencies: pylibftdi
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
FTDI Device | Text | The FTDI device connected to the input/output/etc. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Temperature Compensation: Measurement | Select Measurement (Input, Function) | Select a measurement for temperature compensation |
Temperature Compensation: Max Age (Seconds) | Integer - Default Value: 120 | The maximum age of the measurement to use |
Commands |
Calibration: a one- or two-point calibration can be performed. It's a good idea to clear the calibration before calibrating. Always perform a dry calibration with the probe in the air (not in any fluid). Then perform either a one- or two-point calibration with calibrated solutions. If performing a one-point calibration, use the Single Point Calibration field and button. If performing a two-point calibration, use the Low and High Point Calibration fields and buttons. Allow a minute or two after submerging your probe in a calibration solution for the measurements to equilibrate before calibrating to that solution. The EZO EC circuit default temperature compensation is set to 25 °C. If the temperature of the calibration solution is +/- 2 °C from 25 °C, consider setting the temperature compensation first. Note that at no point should you change the temperature compensation value during calibration. Therefore, if you have previously enabled temperature compensation, allow at least one measurement to occur (to set the compensation value), then disable the temperature compensation measurement while you calibrate. Status messages will be sent to the Daemon Log, accessible from Config -> Mycodo Logs -> Daemon Log. |
Clear Calibration | Button | |
Calibrate Dry | Button | |
Single Point EC (µS) | Integer - Default Value: 84 | The EC (µS) of the single point calibration solution |
Calibrate Single Point | Button | |
Low Point EC (µS) | Integer - Default Value: 12880 | The EC (µS) of the low point calibration solution |
Calibrate Low Point | Button | |
High Point EC (µS) | Integer - Default Value: 80000 | The EC (µS) of the high point calibration solution |
Calibrate High Point | Button | |
The I2C address can be changed. Enter a new address in the 0xYY format (e.g. 0x22, 0x50), then press Set I2C Address. Remember to deactivate and change the I2C address option after setting the new address. |
New I2C Address | Text - Default Value: 0x64 | The new I2C to set the device to |
Set I2C Address | Button | |
Atlas Scientific: Atlas Flow Meter
- Manufacturer: Atlas Scientific
- Measurements: Total Volume, Flow Rate
- Interfaces: I2C, UART, FTDI
- Libraries: pylibftdi/fcntl/io/serial
- Dependencies: pylibftdi
- Manufacturer URL: Link
- Datasheet URL: Link
Set the Measurement Time Base to a value most appropriate for your anticipated flow (it will affect accuracy). This flow rate time base that is set and returned from the sensor will be converted to liters per minute, which is the default unit for this input module. If you desire a different rate to be stored in the database (such as liters per second or hour), then use the Convert to Unit option.
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
FTDI Device | Text | The FTDI device connected to the input/output/etc. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Flow Meter Type | Select(Options: [Atlas Scientific 3/8" Flow Meter | Atlas Scientific 1/4" Flow Meter | Atlas Scientific 1/2" Flow Meter | Atlas Scientific 3/4" Flow Meter | Non-Atlas Scientific Flow Meter] (Default in bold) | Set the type of flow meter used |
Atlas Meter Time Base | Select(Options: [Liters per Second | Liters per Minute | Liters per Hour] (Default in bold) | If using an Atlas Scientific flow meter, set the flow rate/time base |
Internal Resistor | Select(Options: [Use Atlas Scientific Flow Meter | Disable Internal Resistor | 1 K Ω Pull-Up | 1 K Ω Pull-Down | 10 K Ω Pull-Up | 10 K Ω Pull-Down | 100 K Ω Pull-Up | 100 K Ω Pull-Down] (Default in bold) | Set an internal resistor for the flow meter |
Custom K Value(s) | Text | If using a non-Atlas Scientific flow meter, enter the meter's K value(s). For a single K value, enter '[volume per pulse],[number of pulses]'. For multiple K values (up to 16), enter '[volume at frequency],[frequency in Hz];[volume at frequency],[frequency in Hz];...'. Leave blank to disable. |
K Value Time Base | Select(Options: [Use Atlas Scientific Flow Meter | Liters per Second | Liters per Minute | Liters per Hour] (Default in bold) | If using a non-Atlas Scientific flow meter, set the flow rate/time base for the custom K values entered. |
Commands |
The total volume can be cleared with the following button or with the Clear Total Volume Function Action. |
Clear Total: Volume | Button | |
The I2C address can be changed. Enter a new address in the 0xYY format (e.g. 0x22, 0x50), then press Set I2C Address. Remember to deactivate and change the I2C address option after setting the new address. |
New I2C Address | Text - Default Value: 0x68 | The new I2C to set the device to |
Set I2C Address | Button | |
Atlas Scientific: Atlas Humidity
- Manufacturer: Atlas Scientific
- Measurements: Humidity/Temperature
- Interfaces: I2C, UART, FTDI
- Libraries: pylibftdi/fcntl/io/serial
- Dependencies: pylibftdi
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
FTDI Device | Text | The FTDI device connected to the input/output/etc. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
LED Mode | Select(Options: [Always On | Always Off | Only On During Measure] (Default in bold) | When to turn the LED on |
Commands |
New I2C Address | Text - Default Value: 0x6f | The new I2C to set the device to |
Set I2C Address | Button | |
Atlas Scientific: Atlas O2 (Oxygen Gas)
- Manufacturer: Atlas Scientific
- Measurements: O2
- Interfaces: I2C, UART, FTDI
- Libraries: pylibftdi/fcntl/io/serial
- Dependencies: pylibftdi
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
FTDI Device | Text | The FTDI device connected to the input/output/etc. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Temperature Compensation: Measurement | Select Measurement (Input, Function) | Select a measurement for temperature compensation |
Temperature Compensation: Max Age (Seconds) | Integer - Default Value: 120 | The maximum age of the measurement to use |
Temperature Compensation: Manual | Decimal - Default Value: 20.0 | If not using a measurement, set the temperature to compensate |
LED Mode | Select(Options: [Always On | Always Off | Only On During Measure] (Default in bold) | When to turn the LED on |
Commands |
A one- or two-point calibration can be performed. After exposing the probe to a specific concentration of O2 until readings stabilize, press Calibrate (High). You can place the probe in a 0% O2 environment until readings stabilize, then press Calibrate (Zero). You can also clear the currently-saved calibration by pressing Clear Calibration, returning to the factory-set calibration. Status messages will be sent to the Daemon Log, accessible from Config -> Mycodo Logs -> Daemon Log. |
High Point O2 | Decimal - Default Value: 20.95 | The high O2 calibration point (percent) |
Calibrate (High) | Button | |
Calibrate (Zero) | Button | |
Clear Calibration | Button | |
The I2C address can be changed. Enter a new address in the 0xYY format (e.g. 0x22, 0x50), then press Set I2C Address. Remember to deactivate and change the I2C address option after setting the new address. |
New I2C Address | Text - Default Value: 0x69 | The new I2C to set the device to |
Set I2C Address | Button | |
Atlas Scientific: Atlas ORP
- Manufacturer: Atlas Scientific
- Measurements: Oxidation Reduction Potential
- Interfaces: I2C, UART, FTDI
- Libraries: pylibftdi/fcntl/io/serial
- Dependencies: pylibftdi
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
FTDI Device | Text | The FTDI device connected to the input/output/etc. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Temperature Compensation: Measurement | Select Measurement (Input, Function) | Select a measurement for temperature compensation |
Temperature Compensation: Max Age (Seconds) | Integer - Default Value: 120 | The maximum age of the measurement to use |
Commands |
A one-point calibration can be performed. Enter the solution's mV, set the probe in the solution, then press Calibrate. You can also clear the currently-saved calibration by pressing Clear Calibration. Status messages will be sent to the Daemon Log, accessible from Config -> Mycodo Logs -> Daemon Log. |
Calibration Solution mV | Integer - Default Value: 225 | The value of the calibration solution, in mV |
Calibrate | Button | |
Clear Calibration | Button | |
The I2C address can be changed. Enter a new address in the 0xYY format (e.g. 0x22, 0x50), then press Set I2C Address. Remember to deactivate and change the I2C address option after setting the new address. |
New I2C Address | Text - Default Value: 0x62 | The new I2C to set the device to |
Set I2C Address | Button | |
Atlas Scientific: Atlas PT-1000
- Manufacturer: Atlas Scientific
- Measurements: Temperature
- Interfaces: I2C, UART, FTDI
- Libraries: pylibftdi/fcntl/io/serial
- Dependencies: pylibftdi
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
FTDI Device | Text | The FTDI device connected to the input/output/etc. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Commands |
New I2C Address | Text - Default Value: 0x66 | The new I2C to set the device to |
Set I2C Address | Button | |
Temperature (°C) | Decimal - Default Value: 100.0 | Temperature for single point calibration |
Calibrate | Button | |
Clear Calibration | Button | |
Atlas Scientific: Atlas Pressure
- Manufacturer: Atlas Scientific
- Measurements: Pressure
- Interfaces: I2C, UART, FTDI
- Libraries: pylibftdi/fcntl/io/serial
- Dependencies: pylibftdi
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
FTDI Device | Text | The FTDI device connected to the input/output/etc. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
LED Mode | Select(Options: [Always On | Always Off | Only On During Measure] (Default in bold) | When to turn the LED on |
Commands |
New I2C Address | Text - Default Value: 0x6a | The new I2C to set the device to |
Set I2C Address | Button | |
Atlas Scientific: Atlas pH
- Manufacturer: Atlas Scientific
- Measurements: Ion Concentration
- Interfaces: I2C, UART, FTDI
- Libraries: pylibftdi/fcntl/io/serial
- Dependencies: pylibftdi
- Manufacturer URL: Link
- Datasheet URL: Link
Calibration Measurement is an optional setting that provides a temperature measurement (in Celsius) of the water that the pH is being measured from.
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
FTDI Device | Text | The FTDI device connected to the input/output/etc. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Temperature Compensation: Measurement | Select Measurement (Input, Function) | Select a measurement for temperature compensation |
Temperature Compensation: Max Age (Seconds) | Integer - Default Value: 120 | The maximum age of the measurement to use |
Commands |
Calibration: a one-, two- or three-point calibration can be performed. It's a good idea to clear the calibration before calibrating. The first calibration must be the Mid point. The second must be the Low point. And the third must be the High point. You can perform a one-, two- or three-point calibration, but they must be performed in this order. Allow a minute or two after submerging your probe in a calibration solution for the measurements to equilibrate before calibrating to that solution. The EZO pH circuit default temperature compensation is set to 25 °C. If the temperature of the calibration solution is +/- 2 °C from 25 °C, consider setting the temperature compensation first. Note that if you have a Temperature Compensation Measurement selected from the Options, this will overwrite the manual Temperature Compensation set here, so be sure to disable this option if you would like to specify the temperature to compensate with. Status messages will be sent to the Daemon Log, accessible from Config -> Mycodo Logs -> Daemon Log. |
Compensation Temperature (°C) | Decimal - Default Value: 25.0 | The temperature of the calibration solutions |
Set Temperature Compensation | Button | |
Clear Calibration | Button | |
Mid Point pH | Decimal - Default Value: 7.0 | The pH of the mid point calibration solution |
Calibrate Mid | Button | |
Low Point pH | Decimal - Default Value: 4.0 | The pH of the low point calibration solution |
Calibrate Low | Button | |
High Point pH | Decimal - Default Value: 10.0 | The pH of the high point calibration solution |
Calibrate High | Button | |
Calibration Export/Import: Export calibration to a series of strings. These can later be imported to restore the calibration. Watch the Daemon Log for the output. |
Export Calibration | Button | |
Calibration String | Text | The calibration string to import |
Import Calibration | Button | |
The I2C address can be changed. Enter a new address in the 0xYY format (e.g. 0x22, 0x50), then press Set I2C Address. Remember to deactivate and change the I2C address option after setting the new address. |
New I2C Address | Text - Default Value: 0x63 | The new I2C to set the device to |
Set I2C Address | Button | |
BOSCH: BME280 (Adafruit_BME280)
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
BOSCH: BME280 (Adafruit_CircuitPython_BME280)
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
BOSCH: BME280 (RPi.bme280)
- Manufacturer: BOSCH
- Measurements: Pressure/Humidity/Temperature
- Interfaces: I2C
- Libraries: RPi.bme280
- Dependencies: RPi.bme280
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URLs: Link 1, Link 2
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
BOSCH: BME680 (Adafruit_CircuitPython_BME680)
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Humidity Oversampling | Select(Options: [NONE | 1X | 2X | 4X | 8X | 16X] (Default in bold) | A higher oversampling value means more stable readings with less noise and jitter. However each step of oversampling adds ~2 ms latency, causing a slower response time to fast transients. |
Temperature Oversampling | Select(Options: [NONE | 1X | 2X | 4X | 8X | 16X] (Default in bold) | A higher oversampling value means more stable readings with less noise and jitter. However each step of oversampling adds ~2 ms latency, causing a slower response time to fast transients. |
Pressure Oversampling | Select(Options: [NONE | 1X | 2X | 4X | 8X | 16X] (Default in bold) | A higher oversampling value means more stable readings with less noise and jitter. However each step of oversampling adds ~2 ms latency, causing a slower response time to fast transients. |
IIR Filter Size | Select(Options: [0 | 1 | 3 | 7 | 15 | 31 | 63 | 127] (Default in bold) | Optionally remove short term fluctuations from the temperature and pressure readings, increasing their resolution but reducing their bandwidth. |
Temperature Offset | Decimal | The amount to offset the temperature, either negative or positive |
Sea Level Pressure (ha) | Decimal - Default Value: 1013.25 | The pressure at sea level for the sensor location |
BOSCH: BME680 (bme680)
- Manufacturer: BOSCH
- Measurements: Temperature/Humidity/Pressure/Gas
- Interfaces: I2C
- Libraries: bme680
- Dependencies: bme680, smbus2
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URLs: Link 1, Link 2
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Humidity Oversampling | Select(Options: [NONE | 1X | 2X | 4X | 8X | 16X] (Default in bold) | A higher oversampling value means more stable readings with less noise and jitter. However each step of oversampling adds ~2 ms latency, causing a slower response time to fast transients. |
Temperature Oversampling | Select(Options: [NONE | 1X | 2X | 4X | 8X | 16X] (Default in bold) | A higher oversampling value means more stable readings with less noise and jitter. However each step of oversampling adds ~2 ms latency, causing a slower response time to fast transients. |
Pressure Oversampling | Select(Options: [NONE | 1X | 2X | 4X | 8X | 16X] (Default in bold) | A higher oversampling value means more stable readings with less noise and jitter. However each step of oversampling adds ~2 ms latency, causing a slower response time to fast transients. |
IIR Filter Size | Select(Options: [0 | 1 | 3 | 7 | 15 | 31 | 63 | 127] (Default in bold) | Optionally remove short term fluctuations from the temperature and pressure readings, increasing their resolution but reducing their bandwidth. |
Gas Heater Temperature (°C) | Integer - Default Value: 320 | What temperature to set |
Gas Heater Duration (ms) | Integer - Default Value: 150 | How long of a duration to heat. 20-30 ms are necessary for the heater to reach the intended target temperature. |
Gas Heater Profile | Select | Select one of the 10 configured heating durations/set points |
Temperature Offset | Decimal | The amount to offset the temperature, either negative or positive |
BOSCH: BMP180
- Manufacturer: BOSCH
- Measurements: Pressure/Temperature
- Interfaces: I2C
- Libraries: Adafruit_BMP
- Dependencies: Adafruit-BMP, Adafruit-GPIO
- Datasheet URL: Link
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
BOSCH: BMP280 (Adafruit_GPIO)
- Manufacturer: BOSCH
- Measurements: Pressure/Temperature
- Interfaces: I2C
- Libraries: Adafruit_GPIO
- Dependencies: Adafruit-GPIO
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
BOSCH: BMP280 (bmp280-python)
- Manufacturer: BOSCH
- Measurements: Pressure/Temperature
- Interfaces: I2C
- Libraries: bmp280-python
- Dependencies: smbus2, bmp280
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
This is similar to the other BMP280 Input, except it uses a different library, whcih includes the ability to set forced mode.
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Enable Forced Mode | Boolean | Enable heater to evaporate condensation. Turn on heater x seconds every y measurements. |
CO2Meter: K30
- Manufacturer: CO2Meter
- Measurements: CO2
- Interfaces: I2C, UART
- Libraries: serial (UART)
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Catnip Electronics: Chirp
- Manufacturer: Catnip Electronics
- Measurements: Light/Moisture/Temperature
- Interfaces: I2C
- Libraries: smbus2
- Dependencies: smbus2
- Manufacturer URL: Link
- Product URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Commands |
The I2C address can be changed. Enter a new address in the 0xYY format (e.g. 0x22, 0x50), then press Set I2C Address. Remember to deactivate and change the I2C address option after setting the new address. |
New I2C Address | Text - Default Value: 0x20 | The new I2C to set the device to |
Set I2C Address | Button | |
Cozir: Cozir CO2
- Manufacturer: Cozir
- Measurements: CO2/Humidity/Temperature
- Interfaces: UART
- Libraries: pierre-haessig/pycozir
- Dependencies: cozir
- Manufacturer URL: Link
- Datasheet URL: Link
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Generic: Hall Flow Meter
- Manufacturer: Generic
- Measurements: Flow Rate, Total Volume
- Interfaces: GPIO
- Libraries: pigpio
- Dependencies: pigpio, pigpio
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Pulses per Liter | Decimal - Default Value: 1.0 | Enter the conversion factor for this meter (pulses to Liter). |
Commands |
Clear Total: Volume | Button | |
Infineon: DPS310
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
MAXIM: DS1822
- Manufacturer: MAXIM
- Measurements: Temperature
- Interfaces: 1-Wire
- Libraries: w1thermsensor
- Dependencies: w1thermsensor
- Manufacturer URL: Link
- Datasheet URL: Link
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Commands |
Set the resolution, precision, and response time for the sensor. This setting will be written to the EEPROM to allow persistence after power loss. The EEPROM has a limited amount of writes (>50k). |
Resolution | Select | Select the resolution for the sensor |
Set Resolution | Button | |
MAXIM: DS1825
- Manufacturer: MAXIM
- Measurements: Temperature
- Interfaces: 1-Wire
- Libraries: w1thermsensor
- Dependencies: w1thermsensor
- Manufacturer URL: Link
- Datasheet URL: Link
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Commands |
Set the resolution, precision, and response time for the sensor. This setting will be written to the EEPROM to allow persistence after power loss. The EEPROM has a limited amount of writes (>50k). |
Resolution | Select | Select the resolution for the sensor |
Set Resolution | Button | |
MAXIM: DS18B20 (ow-shell)
- Manufacturer: MAXIM
- Measurements: Temperature
- Interfaces: 1-Wire
- Libraries: ow-shell
- Dependencies: ow-shell, owfs
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URLs: Link 1, Link 2, Link 3
- Additional URL: Link
Warning: Counterfeit DS18B20 sensors are common and can cause a host of issues. Review the Additional URL for more information about how to determine if your sensor is authentic.
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
MAXIM: DS18B20 (w1thermsensor)
- Manufacturer: MAXIM
- Measurements: Temperature
- Interfaces: 1-Wire
- Libraries: w1thermsensor
- Dependencies: w1thermsensor
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URLs: Link 1, Link 2, Link 3
- Additional URL: Link
Warning: Counterfeit DS18B20 sensors are common and can cause a host of issues. Review the Additional URL for more information about how to determine if your sensor is authentic.
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Temperature Offset | Decimal | The temperature offset (degrees Celsius) to apply |
Commands |
Set the resolution, precision, and response time for the sensor. This setting will be written to the EEPROM to allow persistence after power loss. The EEPROM has a limited amount of writes (>50k). |
Resolution | Select | Select the resolution for the sensor |
Set Resolution | Button | |
MAXIM: DS18S20
- Manufacturer: MAXIM
- Measurements: Temperature
- Interfaces: 1-Wire
- Libraries: w1thermsensor
- Dependencies: w1thermsensor
- Manufacturer URL: Link
- Datasheet URL: Link
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Commands |
Set the resolution, precision, and response time for the sensor. This setting will be written to the EEPROM to allow persistence after power loss. The EEPROM has a limited amount of writes (>50k). |
Resolution | Select | Select the resolution for the sensor |
Set Resolution | Button | |
MAXIM: DS28EA00
- Manufacturer: MAXIM
- Measurements: Temperature
- Interfaces: 1-Wire
- Libraries: w1thermsensor
- Dependencies: w1thermsensor
- Manufacturer URL: Link
- Datasheet URL: Link
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Commands |
Set the resolution, precision, and response time for the sensor. This setting will be written to the EEPROM to allow persistence after power loss. The EEPROM has a limited amount of writes (>50k). |
Resolution | Select | Select the resolution for the sensor |
Set Resolution | Button | |
MAXIM: MAX31850K
- Manufacturer: MAXIM
- Measurements: Temperature
- Interfaces: 1-Wire
- Libraries: w1thermsensor
- Dependencies: w1thermsensor
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Commands |
Set the resolution, precision, and response time for the sensor. This setting will be written to the EEPROM to allow persistence after power loss. The EEPROM has a limited amount of writes (>50k). |
Resolution | Select | Select the resolution for the sensor |
Set Resolution | Button | |
MAXIM: MAX31855 (Gravity PT100) (smbus2)
- Manufacturer: MAXIM
- Measurements: Temperature
- Interfaces: I2C
- Libraries: smbus2
- Dependencies: smbus2
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
MAXIM: MAX31855 (Gravity PT100) (wiringpi)
- Manufacturer: MAXIM
- Measurements: Temperature
- Interfaces: I2C
- Libraries: wiringpi
- Dependencies: wiringpi
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
MAXIM: MAX31855 (Adafruit_MAX31855)
- Manufacturer: MAXIM
- Measurements: Temperature (Object/Die)
- Interfaces: UART
- Libraries: Adafruit_MAX31855
- Dependencies: Adafruit_MAX31855, Adafruit-GPIO
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
Pin: Cable Select | Integer | GPIO (using BCM numbering): Pin: Cable Select |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
MAXIM: MAX31855 (adafruit-circuitpython-max31855)
- Manufacturer: MAXIM
- Measurements: Temperature (Object/Die)
- Interfaces: SPI
- Libraries: adafruit-circuitpython-max31855
- Dependencies: adafruit-circuitpython-max31855
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Chip Select Pin | Integer - Default Value: 5 | Enter the GPIO Chip Select Pin for your device. |
MAXIM: MAX31856
- Manufacturer: MAXIM
- Measurements: Temperature (Object/Die)
- Interfaces: UART
- Libraries: RPi.GPIO
- Dependencies: RPi.GPIO
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
Pin: Cable Select | Integer | GPIO (using BCM numbering): Pin: Cable Select |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
MAXIM: MAX31865 (Adafruit-CircuitPython-MAX31865)
This module was added to allow support for multiple sensors to be connected at the same time, which the original MAX31865 module was not designed for.
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Chip Select Pin | Integer - Default Value: 8 | Enter the GPIO Chip Select Pin for your device. |
Number of wires | Select(Options: [2 Wires | 3 Wires | 4 Wires] (Default in bold) | Select the number of wires your thermocouple has. |
MAXIM: MAX31865 (RPi.GPIO)
- Manufacturer: MAXIM
- Measurements: Temperature
- Interfaces: UART
- Libraries: RPi.GPIO
- Dependencies: RPi.GPIO
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
Note: This module does not allow for multiple sensors to be connected at the same time. For multi-sensor support, use the MAX31865 CircuitPython Input.
Pin: Cable Select | Integer | GPIO (using BCM numbering): Pin: Cable Select |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
MQTT: MQTT Subscribe (JSON payload)
- Manufacturer: MQTT
- Measurements: Variable measurements
- Interfaces: Mycodo
- Libraries: paho-mqtt, jmespath
- Dependencies: paho-mqtt, jmespath
A single topic is subscribed to and the returned JSON payload contains one or more key/value pairs. The given JSON Key is used as a JMESPATH expression to find the corresponding value that will be stored for that channel. Be sure you select and save the Measurement Unit for each channel. Once the unit has been saved, you can convert to other units in the Convert Measurement section. Example expressions for jmespath (https://jmespath.org) include temperature, sensors[0].temperature, and bathroom.temperature which refer to the temperature as a direct key within the first entry of sensors or as a subkey of bathroom, respectively. Jmespath elements and keys that contain special characters have to be enclosed in double quotes, e.g. "sensor-1".temperature. Warning: If using multiple MQTT Inputs or Functions, ensure the Client IDs are unique.
Measurements Enabled | Multi-Select | The measurements to record |
Host | Text - Default Value: localhost | Host or IP address |
Port | Integer - Default Value: 1883 | Host port number |
Topic | Text - Default Value: mqtt/test/input | The topic to subscribe to |
Keep Alive | Integer - Default Value: 60 | Maximum amount of time between received signals. Set to 0 to disable. |
Client ID | Text - Default Value: client_FGIg092m | Unique client ID for connecting to the server |
Use Login | Boolean | Send login credentials |
Use TLS | Boolean | Send login credentials using TLS |
Username | Text - Default Value: user | Username for connecting to the server |
Password | Text | Password for connecting to the server. Leave blank to disable. |
Use Websockets | Boolean | Use websockets to connect to the server. |
Channel Options |
Name | Text | A name to distinguish this from others |
JMESPATH Expression | Text | JMESPATH expression to find value in JSON response |
MQTT: MQTT Subscribe (Value payload)
- Manufacturer: MQTT
- Measurements: Variable measurements
- Interfaces: Mycodo
- Libraries: paho-mqtt
- Dependencies: paho-mqtt
A topic is subscribed to for each channel Subscription Topic and the returned payload value will be stored for that channel. Be sure you select and save the Measurement Unit for each of the channels. Once the unit has been saved, you can convert to other units in the Convert Measurement section. Warning: If using multiple MQTT Inputs or Functions, ensure the Client IDs are unique.
Measurements Enabled | Multi-Select | The measurements to record |
Host | Text - Default Value: localhost | Host or IP address |
Port | Integer - Default Value: 1883 | Host port number |
Keep Alive | Integer - Default Value: 60 | Maximum amount of time between received signals. Set to 0 to disable. |
Client ID | Text - Default Value: client_mqUgXLvM | Unique client ID for connecting to the server |
Use Login | Boolean | Send login credentials |
Use TLS | Boolean | Send login credentials using TLS |
Username | Text - Default Value: user | Username for connecting to the server |
Password | Text | Password for connecting to the server. Leave blank to disable. |
Use Websockets | Boolean | Use websockets to connect to the server. |
Channel Options |
Name | Text | A name to distinguish this from others |
Subscription Topic | Text | The MQTT topic to subscribe to |
Melexis: MLX90393
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Melexis: MLX90614
- Manufacturer: Melexis
- Measurements: Temperature (Ambient/Object)
- Interfaces: I2C
- Libraries: smbus2
- Dependencies: smbus2
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Microchip: MCP3008 (Adafruit_CircuitPython_MCP3xxx)
- Manufacturer: Microchip
- Measurements: Voltage (Analog-to-Digital Converter)
- Interfaces: UART
- Libraries: Adafruit_CircuitPython_MCP3xxx
- Dependencies: adafruit-circuitpython-mcp3xxx
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
Pin: Cable Select | Integer | GPIO (using BCM numbering): Pin: Cable Select |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
VREF (volts) | Decimal - Default Value: 3.3 | Set the VREF voltage |
Microchip: MCP3008 (Adafruit_MCP3008)
- Manufacturer: Microchip
- Measurements: Voltage (Analog-to-Digital Converter)
- Interfaces: UART
- Libraries: Adafruit_MCP3008
- Dependencies: Adafruit-MCP3008
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
Pin: Cable Select | Integer | GPIO (using BCM numbering): Pin: Cable Select |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
VREF (volts) | Decimal - Default Value: 3.3 | Set the VREF voltage |
Microchip: MCP3208
- Manufacturer: Microchip
- Measurements: Voltage (Analog-to-Digital Converter)
- Interfaces: SPI
- Libraries: MCP3208
- Dependencies: Adafruit-GPIO
- Manufacturer URL: Link
- Datasheet URL: Link
Pin: Cable Select | Integer | GPIO (using BCM numbering): Pin: Cable Select |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
SPI Bus | Integer | The SPI bus ID. |
SPI Device | Integer | The SPI device ID. |
VREF (volts) | Decimal - Default Value: 3.3 | Set the VREF voltage |
Microchip: MCP342x (x=2,3,4,6,7,8)
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Microchip: MCP9808
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Multiple Manufacturers: HC-SR04
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Trigger Pin | Integer | Enter the GPIO Trigger Pin for your device (BCM numbering). |
Echo Pin | Integer | Enter the GPIO Echo Pin for your device (BCM numbering). |
Panasonic: AMG8833
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Power Monitor: RPi Power Monitor (6 Channels)
- Manufacturer: Power Monitor
- Measurements: AC Voltage, Power, Current, Power Factor
- Libraries: rpi-power-monitor
- Dependencies: rpi_power_monitor
- Manufacturer URL: Link
- Product URL: Link
See https://github.com/David00/rpi-power-monitor/wiki/Calibrating-for-Accuracy for calibration procedures.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Grid Voltage | Decimal - Default Value: 124.2 | The AC voltage measured at the outlet |
Transformer Voltage | Decimal - Default Value: 10.2 | The AC voltage measured at the barrel plug of the 9 VAC transformer |
CT1 Phase Correction | Decimal - Default Value: 1.0 | The phase correction value for CT1 |
CT2 Phase Correction | Decimal - Default Value: 1.0 | The phase correction value for CT2 |
CT3 Phase Correction | Decimal - Default Value: 1.0 | The phase correction value for CT3 |
CT4 Phase Correction | Decimal - Default Value: 1.0 | The phase correction value for CT4 |
CT5 Phase Correction | Decimal - Default Value: 1.0 | The phase correction value for CT5 |
CT6 Phase Correction | Decimal - Default Value: 1.0 | The phase correction value for CT6 |
CT1 Accuracy Calibration | Decimal - Default Value: 1.0 | The accuracy calibration value for CT1 |
CT2 Accuracy Calibration | Decimal - Default Value: 1.0 | The accuracy calibration value for CT2 |
CT3 Accuracy Calibration | Decimal - Default Value: 1.0 | The accuracy calibration value for CT3 |
CT4 Accuracy Calibration | Decimal - Default Value: 1.0 | The accuracy calibration value for CT4 |
CT5 Accuracy Calibration | Decimal - Default Value: 1.0 | The accuracy calibration value for CT5 |
CT6 Accuracy Calibration | Decimal - Default Value: 1.0 | The accuracy calibration value for CT6 |
AC Accuracy Calibration | Decimal - Default Value: 1.0 | The accuracy calibration value for AC |
ROHM: BH1750
- Manufacturer: ROHM
- Measurements: Light
- Interfaces: I2C
- Libraries: smbus2
- Dependencies: smbus2
- Datasheet URL: Link
- Product URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Raspberry Pi Foundation: Sense HAT
- Manufacturer: Raspberry Pi Foundation
- Measurements: hum/temp/press/compass/magnet/accel/gyro
- Interfaces: I2C
- Libraries: sense-hat
- Dependencies: git, Bash Commands (see Module for details), sense-hat
- Manufacturer URL: Link
This module acquires measurements from the Raspberry Pi Sense HAT sensors, which include the LPS25H, LSM9DS1, and HTS221.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Ruuvi: RuuviTag
Bluetooth MAC (XX:XX:XX:XX:XX:XX) | Text | The Hci location of the Bluetooth device. |
Bluetooth Adapter (hci[X]) | Text | The adapter of the Bluetooth device. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
STMicroelectronics: VL53L0X
- Manufacturer: STMicroelectronics
- Measurements: Millimeter (Time-of-Flight Distance)
- Interfaces: I2C
- Libraries: VL53L0X_rasp_python
- Dependencies: VL53L0X
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URLs: Link 1, Link 2
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Accuracy | Select(Options: [Good Accuracy (33 ms, 1.2 m range) | Better Accuracy (66 ms, 1.2 m range) | Best Accuracy (200 ms, 1.2 m range) | Long Range (33 ms, 2 m) | High Speed, Low Accuracy (20 ms, 1.2 m)] (Default in bold) | Set the accuracy. A longer measurement duration yields a more accurate measurement |
Commands |
New I2C Address | Text - Default Value: 0x52 | The new I2C to set the device to |
Set I2C Address | Button | |
STMicroelectronics: VL53L1X
- Manufacturer: STMicroelectronics
- Measurements: Millimeter (Time-of-Flight Distance)
- Interfaces: I2C
- Libraries: VL53L1X
- Dependencies: smbus2, vl53l1x
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URLs: Link 1, Link 2
Notes when setting a custom timing budget: A higher timing budget results in greater measurement accuracy, but also a higher power consumption. The inter measurement period must be >= the timing budget, otherwise it will be double the expected value.
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Range | Select(Options: [Short Range | Medium Range | Long Range | Custom Timing Budget] (Default in bold) | Select a range or select to set a custom Timing Budget and Inter Measurement Period. |
Timing Budget (microseconds) | Integer - Default Value: 66000 | Set the timing budget. Must be less than or equal to the Inter Measurement Period. |
Inter Measurement Period (milliseconds) | Integer - Default Value: 70 | Set the Inter Measurement Period |
STMicroelectronics: VL53L4CD
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Timing Budget (ms) | Integer - Default Value: 50 | Set the timing budget between 10 to 200 ms. A longer duration yields a more accurate measurement. |
Inter-Measurement Period (ms) | Integer | Valid range between Timing Budget and 5000 ms (0 to disable) |
Commands |
The I2C address of the sensor can be changed. Enter a new address in the 0xYY format (e.g. 0x22, 0x50), then press Set I2C Address. Remember to deactivate the Input and change the I2C address option after setting the new address. |
New I2C Address | Text - Default Value: 0x29 | The new I2C to set the device to |
Set I2C Address | Button | |
Seeedstudio: DHT11/22
Enter the Grove Pi+ GPIO pin connected to the sensor and select the sensor type.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Sensor Type | Select(Options: [DHT11 (Blue) | DHT22 (White)] (Default in bold) | Sensor type |
Senseair: K96
- Manufacturer: Senseair
- Measurements: Methane/Moisture/CO2/Pressure/Humidity/Temperature
- Interfaces: UART
- Libraries: Serial
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Sensirion: SCD-4x (40, 41)
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Temperature Offset | Decimal - Default Value: 4.0 | Set the sensor temperature offset |
Altitude (m) | Integer | Set the sensor altitude (meters) |
Automatic Self-Calibration | Boolean | Set the sensor automatic self-calibration |
Persist Settings | Boolean - Default Value: True | Settings will persist after powering off |
Commands |
You can force the CO2 calibration for a specific CO2 concentration value (in ppmv). The sensor needs to be active for at least 3 minutes prior to calibration. |
CO2 Concentration (ppmv) | Decimal - Default Value: 400.0 | Calibrate to this CO2 concentration that the sensor is being exposed to (in ppmv) |
Calibrate CO2 | Button | |
Sensirion: SCD30 (Adafruit_CircuitPython_SCD30)
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
I2C Frequency: The SCD-30 has temperamental I2C with clock stretching. The datasheet recommends starting at 50,000 Hz. |
I2C Frequency (Hz) | Integer - Default Value: 50000 |
Automatic Self Ccalibration (ASC): To work correctly, the sensor must be on and active for 7 days after enabling ASC, and exposed to fresh air for at least 1 hour per day. Consult the manufacturer’s documentation for more information. |
Enable Automatic Self Calibration | Boolean |
Temperature Offset: Specifies the offset to be added to the reported measurements to account for a bias in the measured signal. Must be a positive value, and will reduce the recorded temperature by that amount. Give the sensor adequate time to acclimate after setting this value. Value is in degrees Celsius with a resolution of 0.01 degrees and a maximum value of 655.35 C. |
Temperature Offset | Decimal |
Ambient Air Pressure (mBar): Specify the ambient air pressure at the measurement location in mBar. Setting this value adjusts the CO2 measurement calculations to account for the air pressure’s effect on readings. Values must be in mBar, from 700 to 1200 mBar. |
Ambient Air Pressure (mBar) | Integer - Default Value: 1200 |
Altitude: Specifies the altitude at the measurement location in meters above sea level. Setting this value adjusts the CO2 measurement calculations to account for the air pressure’s effect on readings. |
Altitude (m) | Integer - Default Value: 100 |
Commands |
A soft reset restores factory default values. |
Soft Reset | Button | |
Forced Re-Calibration: The SCD-30 is placed in an environment with a known CO2 concentration, this concentration value is entered in the CO2 Concentration (ppmv) field, then the Foce Calibration button is pressed. But how do you come up with that known value? That is a caveat of this approach and Sensirion suggests three approaches: 1. Using a separate secondary calibrated CO2 sensor to provide the value. 2. Exposing the SCD-30 to a controlled environment with a known value. 3. Exposing the SCD-30 to fresh outside air and using a value of 400 ppm. |
CO2 Concentration (ppmv) | Integer - Default Value: 800 | The CO2 concentration of the sensor environment when forcing calibration |
Force Recalibration | Button | |
Sensirion: SCD30 (scd30_i2c)
- Manufacturer: Sensirion
- Measurements: CO2/Humidity/Temperature
- Interfaces: I2C
- Libraries: scd30_i2c
- Dependencies: scd30-i2c
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URLs: Link 1, Link 2
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Automatic Self Ccalibration (ASC): To work correctly, the sensor must be on and active for 7 days after enabling ASC, and exposed to fresh air for at least 1 hour per day. Consult the manufacturer’s documentation for more information. |
Enable Automatic Self Calibration | Boolean |
Commands |
A soft reset restores factory default values. |
Soft Reset | Button | |
Sensirion: SHT1x/7x
- Manufacturer: Sensirion
- Measurements: Humidity/Temperature
- Interfaces: GPIO
- Libraries: sht_sensor
- Dependencies: sht-sensor
- Manufacturer URLs: Link 1, Link 2
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Sensirion: SHT2x (sht20)
- Manufacturer: Sensirion
- Measurements: Humidity/Temperature
- Interfaces: I2C
- Libraries: sht20
- Dependencies: sht20
- Manufacturer URL: Link
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Temperature Resolution | Select(Options: [11-bit | 12-bit | 13-bit | 14-bit] (Default in bold) | The resolution of the temperature measurement |
Sensirion: SHT2x (smbus2)
- Manufacturer: Sensirion
- Measurements: Humidity/Temperature
- Interfaces: I2C
- Libraries: smbus2
- Dependencies: smbus2
- Manufacturer URL: Link
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Sensirion: SHT31-D
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Temperature Offset | Decimal | The temperature offset (degrees Celsius) to apply |
Sensirion: SHT3x (30, 31, 35)
- Manufacturer: Sensirion
- Measurements: Humidity/Temperature
- Interfaces: I2C
- Libraries: Adafruit_SHT31
- Dependencies: Adafruit-GPIO, Adafruit-SHT31
- Manufacturer URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Enable Heater | Boolean | Enable heater to evaporate condensation. Turn on heater x seconds every y measurements |
Heater On Seconds (Seconds) | Decimal - Default Value: 1.0 | How long to turn the heater on |
Heater On Period | Integer - Default Value: 10 | After how many measurements to turn the heater on. This will repeat |
Sensirion: SHT4X
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Sensirion: SHTC3
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Sensorion: SHT31 Smart Gadget
Bluetooth MAC (XX:XX:XX:XX:XX:XX) | Text | The Hci location of the Bluetooth device. |
Bluetooth Adapter (hci[X]) | Text | The adapter of the Bluetooth device. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Download Stored Data | Boolean - Default Value: True | Download the data logged to the device. |
Set Logging Interval (Seconds) | Integer - Default Value: 600 | Set the logging interval the device will store measurements on its internal memory. |
Silicon Labs: SI1145
- Manufacturer: Silicon Labs
- Measurements: Light (UV/Visible/IR), Proximity (cm)
- Interfaces: I2C
- Libraries: si1145
- Dependencies: SI1145
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Silicon Labs: Si7021
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Sonoff: TH16/10 (Tasmota firmware) with AM2301/Si7021
- Manufacturer: Sonoff
- Measurements: Humidity/Temperature
- Libraries: requests
- Dependencies: requests
- Manufacturer URL: Link
This Input module allows the use of any temperature/humidity sensor with the TH10/TH16. Changing the Sensor Name option changes the key that's queried from the returned dictionary of measurements. If you would like to use this module with a version of this device that uses the AM2301, change Sensor Name to AM2301.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
IP Address | Text - Default Value: 192.168.0.100 | The IP address of the device |
Sensor Name | Text - Default Value: SI7021 | The name of the sensor connected to the device (specific key name in the returned dictionary) |
Sonoff: TH16/10 (Tasmota firmware) with AM2301
- Manufacturer: Sonoff
- Measurements: Humidity/Temperature
- Libraries: requests
- Dependencies: requests
- Manufacturer URL: Link
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
IP Address | Text - Default Value: 192.168.0.100 | The IP address of the device |
Sonoff: TH16/10 (Tasmota firmware) with DS18B20
- Manufacturer: Sonoff
- Measurements: Temperature
- Libraries: requests
- Dependencies: requests
- Manufacturer URL: Link
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
IP Address | Text - Default Value: 192.168.0.100 | The IP address of the device |
TE Connectivity: HTU21D (Adafruit_CircuitPython_HTU21D)
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Temperature Offset | Decimal | The temperature offset (degrees Celsius) to apply |
TE Connectivity: HTU21D (pigpio)
- Manufacturer: TE Connectivity
- Measurements: Humidity/Temperature
- Interfaces: I2C
- Libraries: pigpio
- Dependencies: pigpio, pigpio
- Manufacturer URL: Link
- Datasheet URL: Link
- Product URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
TP-Link: Kasa WiFi Power Plug/Strip Energy Statistics
- Manufacturer: TP-Link
- Measurements: kilowatt hours
- Interfaces: IP
- Libraries: python-kasa
- Dependencies: python-kasa, aio_msgpack_rpc
- Manufacturer URL: Link
This measures from several Kasa power devices (plugs/strips) capable of measuring energy consumption. These include, but are not limited to the KP115 and HS600.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Device Type | Select | The type of Kasa device |
Host | Text - Default Value: 0.0.0.0 | Host or IP address |
Asyncio RPC Port | Integer - Default Value: 18108 | The port to start the asyncio RPC server. Must be unique from other Kasa Outputs. |
Commands |
The total kWh can be cleared with the following button or with the Clear Total kWh Function Action. This will also clear all energy stats on the device, not just the total kWh. |
Clear Total: Kilowatt-hour | Button | |
Tasmota: Tasmota Outlet Energy Monitor (HTTP)
- Manufacturer: Tasmota
- Measurements: Total Energy, Amps, Watts
- Interfaces: HTTP
- Libraries: requests
- Manufacturer URL: Link
- Product URL: Link
This input queries the energy usage information from a WiFi outlet that is running the tasmota firmware. There are many WiFi outlets that support tasmota, and many of of those have energy monitoring capabilities. When used with an MQTT Output, you can both control your tasmota outlets as well as mionitor their energy usage.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Host | Text - Default Value: 192.168.0.50 | Host or IP address |
Texas Instruments: ADS1015
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Measurements to Average | Integer - Default Value: 5 | The number of times to measure each channel. An average of the measurements will be stored. |
Texas Instruments: ADS1115: Generic Analog pH/EC
This input relies on an ADS1115 analog-to-digital converter (ADC) to measure pH and/or electrical conductivity (EC) from analog sensors. You can enable or disable either measurement if you want to only connect a pH sensor or an EC sensor by selecting which measurements you want to under Measurements Enabled. Select which channel each sensor is connected to on the ADC. There are default calibration values initially set for the Input. There are also functions to allow you to easily calibrate your sensors with calibration solutions. If you use the Calibrate Slot actions, these values will be calculated and will replace the currently-set values. You can use the Clear Calibration action to delete the database values and return to using the default values. If you delete the Input or create a new Input to use your ADC/sensors with, you will need to recalibrate in order to store new calibration data.
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
ADC Channel: pH | Select(Options: [Channel 0 | Channel 1 | Channel 2 | Channel 3] (Default in bold) | The ADC channel the pH sensor is connected |
ADC Channel: EC | Select(Options: [Channel 0 | Channel 1 | Channel 2 | Channel 3] (Default in bold) | The ADC channel the EC sensor is connected |
Temperature Compensation |
Temperature Compensation: Measurement | Select Measurement (Input, Function) | Select a measurement for temperature compensation |
Temperature Compensation: Max Age (Seconds) | Integer - Default Value: 120 | The maximum age of the measurement to use |
pH Calibration Data |
Cal data: V1 (internal) | Decimal - Default Value: 1.5 | Calibration data: Voltage |
Cal data: pH1 (internal) | Decimal - Default Value: 7.0 | Calibration data: pH |
Cal data: T1 (internal) | Decimal - Default Value: 25.0 | Calibration data: Temperature |
Cal data: V2 (internal) | Decimal - Default Value: 2.032 | Calibration data: Voltage |
Cal data: pH2 (internal) | Decimal - Default Value: 4.0 | Calibration data: pH |
Cal data: T2 (internal) | Decimal - Default Value: 25.0 | Calibration data: Temperature |
EC Calibration Data |
EC cal data: V1 (internal) | Decimal - Default Value: 0.232 | EC calibration data: Voltage |
EC cal data: EC1 (internal) | Decimal - Default Value: 1413.0 | EC calibration data: EC |
EC cal data: T1 (internal) | Decimal - Default Value: 25.0 | EC calibration data: EC |
EC cal data: V2 (internal) | Decimal - Default Value: 2.112 | EC calibration data: Voltage |
EC cal data: EC2 (internal) | Decimal - Default Value: 12880.0 | EC calibration data: EC |
EC cal data: T2 (internal) | Decimal - Default Value: 25.0 | EC calibration data: EC |
Commands |
pH Calibration Actions: Place your probe in a solution of known pH. Set the known pH value in the "Calibration buffer pH" field, and press "Calibrate pH, slot 1". Repeat with a second buffer, and press "Calibrate pH, slot 2". You don't need to change the values under "Custom Options". |
Calibration buffer pH | Decimal - Default Value: 7.0 | This is the nominal pH of the calibration buffer, usually labelled on the bottle. |
Calibrate pH, slot 1 | Button | |
Calibrate pH, slot 2 | Button | |
Clear pH Calibration Slots | Button | |
EC Calibration Actions: Place your probe in a solution of known EC. Set the known EC value in the "Calibration standard EC" field, and press "Calibrate EC, slot 1". Repeat with a second standard, and press "Calibrate EC, slot 2". You don't need to change the values under "Custom Options". |
Calibration standard EC | Decimal - Default Value: 1413.0 | This is the nominal EC of the calibration standard, usually labelled on the bottle. |
Calibrate EC, slot 1 | Button | |
Calibrate EC, slot 2 | Button | |
Clear EC Calibration Slots | Button | |
Texas Instruments: ADS1115
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Measurements to Average | Integer - Default Value: 5 | The number of times to measure each channel. An average of the measurements will be stored. |
Texas Instruments: ADS1256: Generic Analog pH/EC
- Manufacturer: Texas Instruments
- Measurements: Ion Concentration/Electrical Conductivity
- Interfaces: UART
- Libraries: wiringpi, kizniche/PiPyADC-py3
- Dependencies: wiringpi, pipyadc_py3
This input relies on an ADS1256 analog-to-digital converter (ADC) to measure pH and/or electrical conductivity (EC) from analog sensors. You can enable or disable either measurement if you want to only connect a pH sensor or an EC sensor by selecting which measurements you want to under Measurements Enabled. Select which channel each sensor is connected to on the ADC. There are default calibration values initially set for the Input. There are also functions to allow you to easily calibrate your sensors with calibration solutions. If you use the Calibrate Slot actions, these values will be calculated and will replace the currently-set values. You can use the Clear Calibration action to delete the database values and return to using the default values. If you delete the Input or create a new Input to use your ADC/sensors with, you will need to recalibrate in order to store new calibration data.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
ADC Channel: pH | Select(Options: [Not Connected | Channel 0 | Channel 1 | Channel 2 | Channel 3 | Channel 4 | Channel 5 | Channel 6 | Channel 7] (Default in bold) | The ADC channel the pH sensor is connected |
ADC Channel: EC | Select(Options: [Not Connected | Channel 0 | Channel 1 | Channel 2 | Channel 3 | Channel 4 | Channel 5 | Channel 6 | Channel 7] (Default in bold) | The ADC channel the EC sensor is connected |
Temperature Compensation |
Temperature Compensation: Measurement | Select Measurement (Input, Function) | Select a measurement for temperature compensation |
Temperature Compensation: Max Age (Seconds) | Integer - Default Value: 120 | The maximum age of the measurement to use |
pH Calibration Data |
Cal data: V1 (internal) | Decimal - Default Value: 1.5 | Calibration data: Voltage |
Cal data: pH1 (internal) | Decimal - Default Value: 7.0 | Calibration data: pH |
Cal data: T1 (internal) | Decimal - Default Value: 25.0 | Calibration data: Temperature |
Cal data: V2 (internal) | Decimal - Default Value: 2.032 | Calibration data: Voltage |
Cal data: pH2 (internal) | Decimal - Default Value: 4.0 | Calibration data: pH |
Cal data: T2 (internal) | Decimal - Default Value: 25.0 | Calibration data: Temperature |
EC Calibration Data |
EC cal data: V1 (internal) | Decimal - Default Value: 0.232 | EC calibration data: Voltage |
EC cal data: EC1 (internal) | Decimal - Default Value: 1413.0 | EC calibration data: EC |
EC cal data: T1 (internal) | Decimal - Default Value: 25.0 | EC calibration data: EC |
EC cal data: V2 (internal) | Decimal - Default Value: 2.112 | EC calibration data: Voltage |
EC cal data: EC2 (internal) | Decimal - Default Value: 12880.0 | EC calibration data: EC |
EC cal data: T2 (internal) | Decimal - Default Value: 25.0 | EC calibration data: EC |
Calibration | Select | Set the calibration method to perform during Input activation |
Commands |
pH Calibration Actions: Place your probe in a solution of known pH. Set the known pH value in the `Calibration buffer pH` field, and press `Calibrate pH, slot 1`. Repeat with a second buffer, and press `Calibrate pH, slot 2`. You don't need to change the values under `Custom Options`. |
Calibration buffer pH | Decimal - Default Value: 7.0 | This is the nominal pH of the calibration buffer, usually labelled on the bottle. |
Calibrate pH, slot 1 | Button | |
Calibrate pH, slot 2 | Button | |
Clear pH Calibration Slots | Button | |
EC Calibration Actions: Place your probe in a solution of known EC. Set the known EC value in the `Calibration standard EC` field, and press `Calibrate EC, slot 1`. Repeat with a second standard, and press `Calibrate EC, slot 2`. You don't need to change the values under `Custom Options`. |
Calibration standard EC | Decimal - Default Value: 1413.0 | This is the nominal EC of the calibration standard, usually labelled on the bottle. |
Calibrate EC, slot 1 | Button | |
Calibrate EC, slot 2 | Button | |
Clear EC Calibration Slots | Button | |
Texas Instruments: ADS1256
- Manufacturer: Texas Instruments
- Measurements: Voltage (Waveshare, Analog-to-Digital Converter)
- Interfaces: UART
- Libraries: wiringpi, kizniche/PiPyADC-py3
- Dependencies: wiringpi, pipyadc_py3
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Calibration | Select | Set the calibration method to perform during Input activation |
Texas Instruments: ADS1x15
- Manufacturer: Texas Instruments
- Measurements: Voltage (Analog-to-Digital Converter)
- Interfaces: I2C
- Libraries: Adafruit_ADS1x15 [DEPRECATED]
- Dependencies: Adafruit-GPIO, Adafruit-ADS1x15
The Adafruit_ADS1x15 is deprecated. It's advised to use The Circuit Python ADS1x15 Input.
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Measurements to Average | Integer - Default Value: 5 | The number of times to measure each channel. An average of the measurements will be stored. |
Texas Instruments: HDC1000
- Manufacturer: Texas Instruments
- Measurements: Humidity/Temperature
- Interfaces: I2C
- Libraries: fcntl/io
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Texas Instruments: INA219x
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Measurements to Average | Integer - Default Value: 5 | The number of times to measure each channel. An average of the measurements will be stored. |
Calibration Range | Select(Options: [32V @ 2A max (default) | 32V @ 1A max | 16V @ 400mA max | 16V @ 5A max] (Default in bold) | Set the device calibration range |
Bus Voltage Range | Select(Options: [(0x00) - 16V | (0x01) - 32V (default)] (Default in bold) | Set the bus voltage range |
Bus ADC Resolution | Select(Options: [(0x00) - 9 Bit / 1 Sample | (0x01) - 10 Bit / 1 Sample | (0x02) - 11 Bit / 1 Sample | (0x03) - 12 Bit / 1 Sample (default) | (0x09) - 12 Bit / 2 Samples | (0x0A) - 12 Bit / 4 Samples | (0x0B) - 12 Bit / 8 Samples | (0x0C) - 12 Bit / 16 Samples | (0x0D) - 12 Bit / 32 Samples | (0x0E) - 12 Bit / 64 Samples | (0x0F) - 12 Bit / 128 Samples] (Default in bold) | Set the Bus ADC Resolution. |
Shunt ADC Resolution | Select(Options: [(0x00) - 9 Bit / 1 Sample | (0x01) - 10 Bit / 1 Sample | (0x02) - 11 Bit / 1 Sample | (0x03) - 12 Bit / 1 Sample (default) | (0x09) - 12 Bit / 2 Samples | (0x0A) - 12 Bit / 4 Samples | (0x0B) - 12 Bit / 8 Samples | (0x0C) - 12 Bit / 16 Samples | (0x0D) - 12 Bit / 32 Samples | (0x0E) - 12 Bit / 64 Samples | (0x0F) - 12 Bit / 128 Samples] (Default in bold) | Set the Shunt ADC Resolution. |
Texas Instruments: TMP006
- Manufacturer: Texas Instruments
- Measurements: Temperature (Object/Die)
- Interfaces: I2C
- Libraries: Adafruit_TMP
- Dependencies: Adafruit-TMP
- Datasheet URL: Link
- Product URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
The Things Network: The Things Network: Data Storage (TTN v2)
- Manufacturer: The Things Network
- Measurements: Variable measurements
- Libraries: requests
- Dependencies: requests
This Input receives and stores measurements from the Data Storage Integration on The Things Network.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Start Offset (Seconds) | Integer | The duration to wait before the first operation |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Application ID | Text | The Things Network Application ID |
App API Key | Text | The Things Network Application API Key |
Device ID | Text | The Things Network Device ID |
Channel Options |
Name | Text | A name to distinguish this from others |
Variable Name | Text | The TTN variable name |
The Things Network: The Things Network: Data Storage (TTN v3, Payload Key)
- Manufacturer: The Things Network
- Measurements: Variable measurements
- Libraries: requests
- Dependencies: requests
This Input receives and stores measurements from the Data Storage Integration on The Things Network. If you have key/value pairs as your payload, enter the key name in Variable Name and the corresponding value for that key will be stored in the measurement database.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Start Offset (Seconds) | Integer | The duration to wait before the first operation |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Application ID | Text | The Things Network Application ID |
App API Key | Text | The Things Network Application API Key |
Device ID | Text | The Things Network Device ID |
Channel Options |
Name | Text | A name to distinguish this from others |
Variable Name | Text | The TTN variable name |
The Things Network: The Things Network: Data Storage (TTN v3, Payload jmespath Expression)
- Manufacturer: The Things Network
- Measurements: Variable measurements
- Libraries: requests, jmespath
- Dependencies: requests, jmespath
This Input receives and stores measurements from the Data Storage Integration on The Things Network. The given Payload jmespath Expression is used as a JMESPATH expression to find the corresponding value that will be stored for that channel. Be sure you select and save the Measurement Unit for each channel. Once the unit has been saved, you can convert to other units in the Convert Measurement section. Example expressions for jmespath (https://jmespath.org) include temperature, sensors[0].temperature, and bathroom.temperature which refer to the temperature as a direct key within the first entry of sensors or as a subkey of bathroom, respectively. Jmespath elements and keys that contain special characters have to be enclosed in double quotes, e.g. "sensor-1".temperature.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Start Offset (Seconds) | Integer | The duration to wait before the first operation |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Application ID | Text | The Things Network Application ID |
App API Key | Text | The Things Network Application API Key |
Device ID | Text | The Things Network Device ID |
Channel Options |
Name | Text | A name to distinguish this from others |
Payload jmespath Expression | Text | The TTN jmespath expression to return the value to store |
Weather: OpenWeatherMap (City, Current)
- Manufacturer: Weather
- Measurements: Humidity/Temperature/Pressure/Wind
- Additional URL: Link
Obtain a free API key at openweathermap.org. If the city you enter does not return measurements, try another city. Note: the free API subscription is limited to 60 calls per minute
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
API Key | Text | The API Key for this service's API |
City | Text | The city to acquire the weather data |
Weather: OpenWeatherMap (Lat/Lon, Current/Future)
- Manufacturer: Weather
- Measurements: Humidity/Temperature/Pressure/Wind
- Interfaces: Mycodo
- Additional URL: Link
Obtain a free API key at openweathermap.org. Notes: The free API subscription is limited to 60 calls per minute. If a Day (Future) time is selected, Minimum and Maximum temperatures are available as measurements.
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
API Key | Text | The API Key for this service's API |
Latitude (decimal) | Decimal - Default Value: 33.441792 | The latitude to acquire weather data |
Longitude (decimal) | Decimal - Default Value: -94.037689 | The longitude to acquire weather data |
Time | Select(Options: [Current (Present) | 1 Day (Future) | 2 Day (Future) | 3 Day (Future) | 4 Day (Future) | 5 Day (Future) | 6 Day (Future) | 7 Day (Future) | 1 Hour (Future) | 2 Hours (Future) | 3 Hours (Future) | 4 Hours (Future) | 5 Hours (Future) | 6 Hours (Future) | 7 Hours (Future) | 8 Hours (Future) | 9 Hours (Future) | 10 Hours (Future) | 11 Hours (Future) | 12 Hours (Future) | 13 Hours (Future) | 14 Hours (Future) | 15 Hours (Future) | 16 Hours (Future) | 17 Hours (Future) | 18 Hours (Future) | 19 Hours (Future) | 20 Hours (Future) | 21 Hours (Future) | 22 Hours (Future) | 23 Hours (Future) | 24 Hours (Future) | 25 Hours (Future) | 26 Hours (Future) | 27 Hours (Future) | 28 Hours (Future) | 29 Hours (Future) | 30 Hours (Future) | 31 Hours (Future) | 32 Hours (Future) | 33 Hours (Future) | 34 Hours (Future) | 35 Hours (Future) | 36 Hours (Future) | 37 Hours (Future) | 38 Hours (Future) | 39 Hours (Future) | 40 Hours (Future) | 41 Hours (Future) | 42 Hours (Future) | 43 Hours (Future) | 44 Hours (Future) | 45 Hours (Future) | 46 Hours (Future) | 47 Hours (Future) | 48 Hours (Future)] (Default in bold) | Select the time for the current or forecast weather |
Winsen: MH-Z14A
- Manufacturer: Winsen
- Measurements: CO2
- Interfaces: UART
- Libraries: serial
- Dependencies: RPi.GPIO
- Manufacturer URL: Link
- Datasheet URL: Link
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Automatic Self-calibration | Boolean - Default Value: True | Enable automatic self-calibration |
Measurement Range | Select(Options: [400 - 2000 ppmv | 400 - 5000 ppmv | 400 - 10000 ppmv] (Default in bold) | Set the measuring range of the sensor |
The CO2 measurement can also be obtained using PWM via a GPIO pin. Enter the pin number below or leave blank to disable this option. This also makes it possible to obtain measurements even if the UART interface is not available (note that the sensor can't be configured / calibrated without a working UART interface). |
GPIO Override | Text | Obtain readings using PWM on this GPIO pin instead of via UART |
Commands |
Calibrate Zero Point | Button | |
Span Point (ppmv) | Integer - Default Value: 2000 | The ppmv concentration for a span point calibration |
Calibrate Span Point | Button | |
Winsen: MH-Z16
- Manufacturer: Winsen
- Measurements: CO2
- Interfaces: UART, I2C
- Libraries: smbus2/serial
- Dependencies: smbus2
- Manufacturer URL: Link
- Datasheet URL: Link
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Winsen: MH-Z19
- Manufacturer: Winsen
- Measurements: CO2
- Interfaces: UART
- Libraries: serial
- Datasheet URL: Link
This is the version of the sensor that does not include the ability to conduct automatic baseline correction (ABC). See the B version of the sensor if you wish to use ABC.
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Measurement Range | Select(Options: [0 - 1000 ppmv | 0 - 2000 ppmv | 0 - 3000 ppmv | 0 - 5000 ppmv] (Default in bold) | Set the measuring range of the sensor |
Commands |
Calibrate Zero Point | Button | |
Span Point (ppmv) | Integer - Default Value: 2000 | The ppmv concentration for a span point calibration |
Calibrate Span Point | Button | |
Winsen: MH-Z19B
- Manufacturer: Winsen
- Measurements: CO2
- Interfaces: UART
- Libraries: serial
- Manufacturer URL: Link
- Datasheet URL: Link
This is the B version of the sensor that includes the ability to conduct automatic baseline correction (ABC).
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Automatic Baseline Correction | Boolean | Enable automatic baseline correction (ABC) |
Measurement Range | Select(Options: [0 - 1000 ppmv | 0 - 2000 ppmv | 0 - 3000 ppmv | 0 - 5000 ppmv | 0 - 10000 ppmv] (Default in bold) | Set the measuring range of the sensor |
Commands |
Calibrate Zero Point | Button | |
Span Point (ppmv) | Integer - Default Value: 2000 | The ppmv concentration for a span point calibration |
Calibrate Span Point | Button | |
Winsen: ZH03B
- Manufacturer: Winsen
- Measurements: Particulates
- Interfaces: UART
- Libraries: serial
- Manufacturer URL: Link
- Datasheet URL: Link
UART Device | Text | The UART device location (e.g. /dev/ttyUSB1) |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Fan Off After Measure | Boolean | Turn the fan on only during the measurement |
Fan On Duration (Seconds) | Decimal - Default Value: 50.0 | How long to turn the fan on before acquiring measurements |
Number of Measurements | Integer - Default Value: 3 | How many measurements to acquire. If more than 1 are acquired that are less than 1001, the average of the measurements will be stored. |
Xiaomi: Miflora
- Manufacturer: Xiaomi
- Measurements: EC/Light/Moisture/Temperature
- Interfaces: BT
- Libraries: miflora
- Dependencies: libglib2.0-dev, miflora, bluepy
Bluetooth MAC (XX:XX:XX:XX:XX:XX) | Text | The Hci location of the Bluetooth device. |
Bluetooth Adapter (hci[X]) | Text | The adapter of the Bluetooth device. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Xiaomi: Mijia LYWSD03MMC (ATC and non-ATC modes)
More information about ATC mode can be found at https://github.com/JsBergbau/MiTemperature2
Bluetooth MAC (XX:XX:XX:XX:XX:XX) | Text | The Hci location of the Bluetooth device. |
Bluetooth Adapter (hci[X]) | Text | The adapter of the Bluetooth device. |
Measurements Enabled | Multi-Select | The measurements to record |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |
Enable ATC Mode | Boolean | Enable sensor ATC mode |
ams: AS7341
I2C Address | Text | The address of the I2C device. |
I2C Bus | Integer | The Bus the I2C device is connected. |
Period (Seconds) | Decimal | The duration between measurements or actions |
Pre Output | Select | Turn the selected output on before taking every measurement |
Pre Out Duration (Seconds) | Decimal | If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired. |
Pre During Measure | Boolean | Check to turn the output off after (opposed to before) the measurement is complete |