Supported Functions

• 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.
• 中文: 此页面未翻译成中文.

Built-In Functions~

Average (Last, Multiple)~

This function acquires the last measurement of those that are selected, averages them, then stores the resulting value as the selected measurement and unit.

Average (Past, Single)~

This function acquires the past measurements (within Max Age) for the selected measurement, averages them, then stores the resulting value as the selected measurement and unit. Note: There is a bug in InfluxDB 1.8.10 that prevents the mean() function from working properly. Therefore, if you are using Influxdb v1.x, the median() function will be used. InfluxDB 2.x is unaffected and uses mean(). To get the true mean, upgrade to InfluxDB 2.x.

Backup to Remote Host (rsync)~

• Dependencies: rsync

This function will use rsync to back up assets on this system to a remote system. Your remote system needs to have an SSH server running and rsync installed. This system will need rsync installed and be able to access your remote system via SSH keyfile (login without a password). You can do this by creating an SSH key on this system running Mycodo with "ssh-keygen" (leave the password field empty), then run "ssh-copy-id -i ~/.ssh/id_rsa.pub pi@REMOTE_HOST_IP" to transfer your public SSH key to your remote system (changing pi and REMOTE_HOST_IP to the appropriate user and host of your remote system). You can test if this worked by trying to connect to your remote system with "ssh pi@REMOTE_HOST_IP" and you should log in without being asked for a password. Be careful not to set the Period too low, which could cause the function to begin running before the previous operation(s) complete. Therefore, it is recommended to set a relatively long Period (greater than 10 minutes). The default Period is 15 days. Note that the Period will reset if the system or the Mycodo daemon restarts and the Function will run, generating new settings and measurement archives that will be synced. There are two common ways to use this Function: 1) A short period (1 hour), only have Backup Camera Directories enabled, and use the Backup Settings Now and Backup Measurements Now buttons manually to perform a backup, and 2) A long period (15 days), only have Backup Settings and Backup Measurements enabled. You can even create two of these Functions with one set up to perform long-Period settings and measurement backups and the other set up to perform short-Period camera backups.

Bang-Bang Hysteretic (On/Off) (Raise/Lower)~

A simple bang-bang control for controlling one output from one input. Select an input, an output, enter a setpoint and a hysteresis, and select a direction. The output will turn on when the input is below (lower = setpoint - hysteresis) and turn off when the input is above (higher = setpoint + hysteresis). This is the behavior when Raise is selected, such as when heating. Lower direction has the opposite behavior - it will try to turn the output on in order to drive the input lower.

Bang-Bang Hysteretic (On/Off) (Raise/Lower/Both)~

A simple bang-bang control for controlling one or two outputs from one input. Select an input, a raise and/or lower output, enter a setpoint and a hysteresis, and select a direction. The output will turn on when the input is below (lower = setpoint - hysteresis) and turn off when the input is above (higher = setpoint + hysteresis). This is the behavior when Raise is selected, such as when heating. Lower direction has the opposite behavior - it will try to turn the output on in order to drive the input lower. The Both option will raise and lower. Note: This output will only work with On/Off Outputs.

Bang-Bang Hysteretic (PWM) (Raise/Lower/Both)~

A simple bang-bang control for controlling one PWM output from one input. Select an input, a PWM output, enter a setpoint and a hysteresis, and select a direction. The output will turn on when the input is below below (lower = setpoint - hysteresis) and turn off when the input is above (higher = setpoint + hysteresis). This is the behavior when Raise is selected, such as when heating. Lower direction has the opposite behavior - it will try to turn the output on in order to drive the input lower. The Both option will raise and lower. Note: This output will only work with PWM Outputs.

Camera: libcamera: Image/Video~

• Dependencies: libcamera-apps, ffmpeg

NOTE: THIS IS CURRENTLY EXPERIMENTAL - USE AT YOUR OWN RISK UNTIL THIS NOTICE IS REMOVED. Capture images and videos from a camera using libcamera-still and libcamera-vid. The Function must be activated in order to capture still and timelapse images and use the Camera Widget.

Difference~

This function acquires 2 measurements, calculates the difference, and stores the resulting value as the selected measurement and unit.

Display: Generic LCD 16x2 (I2C)~

• Dependencies: smbus2

This Function outputs to a generic 16x2 LCD display via I2C. Since this display can show 2 lines at a time, channels are added in sets of 2 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first 2 lines that are displayed are channels 0 and 1, then 2 and 3, and so on. After all channels have been displayed, it will cycle back to the beginning.

Display: Generic LCD 20x4 (I2C)~

• Dependencies: smbus2

This Function outputs to a generic 20x4 LCD display via I2C. Since this display can show 4 lines at a time, channels are added in sets of 4 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first 4 lines that are displayed are channels 0, 1, 2, and 3, then 4, 5, 6, and 7, and so on. After all channels have been displayed, it will cycle back to the beginning.

Display: Grove LCD 16x2 (I2C)~

• Dependencies: smbus2

This Function outputs to the Grove 16x2 LCD display via I2C. Since this display can show 2 lines at a time, channels are added in sets of 2 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first 2 lines that are displayed are channels 0 and 1, then 2 and 3, and so on. After all channels have been displayed, it will cycle back to the beginning.

Display: SSD1306 OLED 128x32 [2 Lines] (I2C)~

• Dependencies: libjpeg-dev, Pillow, pyusb, Adafruit-extended-bus, adafruit-circuitpython-framebuf, adafruit-circuitpython-ssd1306

This Function outputs to a 128x32 SSD1306 OLED display via I2C. This display Function will show 2 lines at a time, so channels are added in sets of 2 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first set of lines that are displayed are channels 0 - 1, then 2 - 3, and so on. After all channels have been displayed, it will cycle back to the beginning.

Display: SSD1306 OLED 128x32 [2 Lines] (SPI)~

• Dependencies: libjpeg-dev, Pillow, pyusb, Adafruit-GPIO, Adafruit-extended-bus, adafruit-circuitpython-framebuf, adafruit-circuitpython-ssd1306

This Function outputs to a 128x32 SSD1306 OLED display via SPI. This display Function will show 2 lines at a time, so channels are added in sets of 2 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first set of lines that are displayed are channels 0 - 1, then 2 - 3, and so on. After all channels have been displayed, it will cycle back to the beginning.

Display: SSD1306 OLED 128x32 [4 Lines] (I2C)~

• Dependencies: libjpeg-dev, Pillow, pyusb, Adafruit-extended-bus, adafruit-circuitpython-framebuf, adafruit-circuitpython-ssd1306

This Function outputs to a 128x32 SSD1306 OLED display via I2C. This display Function will show 4 lines at a time, so channels are added in sets of 4 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first set of lines that are displayed are channels 0 - 3, then 4 - 7, and so on. After all channels have been displayed, it will cycle back to the beginning.

Display: SSD1306 OLED 128x32 [4 Lines] (SPI)~

• Dependencies: libjpeg-dev, Pillow, pyusb, Adafruit-GPIO, Adafruit-extended-bus, adafruit-circuitpython-framebuf, adafruit-circuitpython-ssd1306

This Function outputs to a 128x32 SSD1306 OLED display via SPI. This display Function will show 4 lines at a time, so channels are added in sets of 4 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first set of lines that are displayed are channels 0 - 3, then 4 - 7, and so on. After all channels have been displayed, it will cycle back to the beginning.

Display: SSD1306 OLED 128x64 [4 Lines] (I2C)~

• Dependencies: libjpeg-dev, Pillow, pyusb, Adafruit-extended-bus, adafruit-circuitpython-framebuf, adafruit-circuitpython-ssd1306

This Function outputs to a 128x64 SSD1306 OLED display via I2C. This display Function will show 4 lines at a time, so channels are added in sets of 4 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first set of lines that are displayed are channels 0 - 3, then 4 - 7, and so on. After all channels have been displayed, it will cycle back to the beginning.

Display: SSD1306 OLED 128x64 [4 Lines] (SPI)~

• Dependencies: libjpeg-dev, Pillow, pyusb, Adafruit-GPIO, Adafruit-extended-bus, adafruit-circuitpython-framebuf, adafruit-circuitpython-ssd1306

This Function outputs to a 128x64 SSD1306 OLED display via SPI. This display Function will show 4 lines at a time, so channels are added in sets of 4 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first set of lines that are displayed are channels 0 - 3, then 4 - 7, and so on. After all channels have been displayed, it will cycle back to the beginning.

Display: SSD1306 OLED 128x64 [8 Lines] (I2C)~

• Dependencies: libjpeg-dev, Pillow, pyusb, Adafruit-extended-bus, adafruit-circuitpython-framebuf, adafruit-circuitpython-ssd1306

This Function outputs to a 128x64 SSD1306 OLED display via I2C. This display Function will show 8 lines at a time, so channels are added in sets of 8 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first set of lines that are displayed are channels 0 - 7, then 8 - 15, and so on. After all channels have been displayed, it will cycle back to the beginning.

Display: SSD1306 OLED 128x64 [8 Lines] (SPI)~

• Dependencies: libjpeg-dev, Pillow, pyusb, Adafruit-GPIO, Adafruit-extended-bus, adafruit-circuitpython-framebuf, adafruit-circuitpython-ssd1306

This Function outputs to a 128x64 SSD1306 OLED display via SPI. This display Function will show 8 lines at a time, so channels are added in sets of 8 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first set of lines that are displayed are channels 0 - 7, then 8 - 15, and so on. After all channels have been displayed, it will cycle back to the beginning.

Display: SSD1309 OLED 128x64 [8 Lines] (I2C)~

• Dependencies: pyusb, luma.oled, Pillow, libjpeg-dev, zlib1g-dev, libfreetype6-dev, liblcms2-dev, libopenjp2-7, libtiff5

This Function outputs to a 128x64 SSD1309 OLED display via I2C. This display Function will show 8 lines at a time, so channels are added in sets of 8 when Number of Line Sets is modified. Every Period, the LCD will refresh and display the next set of lines. Therefore, the first set of lines that are displayed are channels 0 - 7, then 8 - 15, and so on. After all channels have been displayed, it will cycle back to the beginning.

Equation (Multi-Measure)~

This function acquires two measurements and uses them within a user-set equation and stores the resulting value as the selected measurement and unit.

Equation (Single-Measure)~

This function acquires a measurement and uses it within a user-set equation and stores the resulting value as the selected measurement and unit.

Example: Generic~

• Dependencies: build-essential

This is an example Function Module that showcases all the different type of UI options. It is not useful beyond showing how to develop new custom Function modules.This message will appear above the Function options. It will retrieve the last selected measurement, turn the selected output on for 15 seconds, then deactivate itself. Study the code to develop your own Function Module that can be imported on the Function Import page.

Humidity (Wet/Dry-Bulb)~

This function calculates the humidity based on wet and dry bulb temperature measurements.

Neokey 4x1 Neopixel Keyboard (Execute Actions)~

• Dependencies: pyusb, Adafruit-extended-bus, adafruit-circuitpython-neokey

This Function executes actions when a key is pressed. Add actions at the bottom of this module, then enter one or more short action IDs for each key, separated by commas. The Action ID is found next to the Action (for example, the Action "[Action 0559689e] Controller: Activate" has an Action ID of 0559689e. When entering Action ID(s), separate multiple IDs by commas (for example, "asdf1234" or "asdf1234,qwer5678,zxcv0987"). Actions will be executed in the order they are entered in the text string. Enter Action IDs to execute those actions when the key is pressed. If enable Toggling Actions, every other key press will execute Actions listed in Toggled Action IDs. The LED color of the key before being pressed, after being pressed, and while the last action is running. Color is an RGB string, with 0-255 for each color. For example, red is "255, 0, 0" and blue is "0, 0, 255".

PID Autotune~

This function will attempt to perform a PID controller autotune. That is, an output will be powered and the response measured from a sensor several times to calculate the P, I, and D gains. Updates about the operation will be sent to the Daemon log. If the autotune successfully completes, a summary will be sent to the Daemon log as well. Currently, only raising a Measurement is supported, but lowering should be possible with some modification to the function controller code. It is recommended to create a graph on a dashboard with the Measurement and Output to monitor that the Output is successfully raising the Measurement beyond the Setpoint. Note: Autotune is an experimental feature, it is not well-developed, and it has a high likelihood of failing to generate PID gains. Do not rely on it for accurately tuning your PID controller.

Redundancy~

This function stores the first available measurement. This is useful if you have multiple sensors that you want to serve as backups in case one stops working, you can set them up in the order of importance. This function will check if a measurement exits, starting with the first measurement. If it doesn't, the next is checked, until a measurement is found. Once a measurement is found, it is stored in the database with the user-set measurement and unit. The output of this function can be used as an input throughout Mycodo. If you need more than 3 measurements to be checked, you can string multiple Redundancy Functions by creating a second Function and setting the first Function's output as the second Function's input.

Regulate pH and Electrical Conductivity~

This function regulates pH with 2 pumps (acid and base solutions) and electrical conductivity (EC) with up to 4 pumps (nutrient solutions A, B, C, and D). Set only the nutrient solution outputs you want to use. Any outputs not set will not dispense when EC is being adjusted, allowing as few as 1 pump or as many as 4 pumps. Outputs can be instructed to turn on for durations (seconds) or volumes (ml). Set each Output Type to the correct type for each selected Output Channel (only select on/off Output Channels for durations and volume Output Channels for volumes). The ratio of nutrient solutions being dispensed is defined by the duration or volume set for each EC output.
If an e-mail address (or multiple addresses separated by commas) is entered into the E-Mail Notification field, a notification e-mail will be sent if 1) pH is outside the set danger range, 2) EC is too high and water needs to be added to the reservoir, or 3) a measurement could not be found in the database for the specific Max Age. Each e-mail notification type has its own timer that prevents e-mail spam, and will only allow sending for each notification type every set E-Mail Timer Duration. After this duration, the timer will automatically reset to allow new notifications to be sent. You may also manually reset e-mail timers at any time with the Custom Commands, below.
When the Function is active, Status text will appear below indicating the regulation information and total duration/volume for each output.

Spacer~

A spacer to organize Functions.

Statistics (Last, Multiple)~

This function acquires multiple measurements, calculates statistics, and stores the resulting values as the selected unit.

Statistics (Past, Single)~

This function acquires multiple values from a single measurement, calculates statistics, and stores the resulting values as the selected unit.

Sum (Last, Multiple)~

This function acquires the last measurement of those that are selected, sums them, then stores the resulting value as the selected measurement and unit.

Sum (Past, Single)~

This function acquires the past measurements (within Max Age) for the selected measurement, sums them, then stores the resulting value as the selected measurement and unit.

Vapor Pressure Deficit~

This function calculates the vapor pressure deficit based on leaf temperature and humidity.

Verification~

This function acquires 2 measurements, calculates the difference, and if the difference is not larger than the set threshold, the Measurement A value is stored. This enables verifying one sensor's measurement with another sensor's measurement. Only when they are both in agreement is a measurement stored. This stored measurement can be used in functions such as Conditional Functions that will notify the user if no measurement is available to indicate there may be an issue with a sensor.