You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Supported-Functions.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -388,9 +388,9 @@ This function will attempt to perform a PID controller autotune. That is, an out
388
388
### Redundancy
389
389
390
390
391
-
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.
391
+
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. If Average Measurements is enabled, the output will be the average of any valid values that are available from the selected measurements.
- Default Value: 60</td><td>The duration between measurements or actions</td></tr><tr><td>Measurement A</td><td>Select Measurement (Input, Function)</td><td>Measurement to replace a</td></tr><tr><td>Measurement A: Max Age (Seconds)</td><td>Integer
393
+
- Default Value: 60</td><td>The duration between measurements or actions</td></tr><tr><td>Average Measurements</td><td>Boolean</td><td>Store the average of multiple valid measurements</td></tr><tr><td>Measurement A</td><td>Select Measurement (Input, Function)</td><td>Measurement to replace a</td></tr><tr><td>Measurement A: Max Age (Seconds)</td><td>Integer
394
394
- Default Value: 360</td><td>The maximum age of the measurement to use</td></tr><tr><td>Measurement B</td><td>Select Measurement (Input, Function)</td><td>Measurement to replace b</td></tr><tr><td>Measurement B: Max Age (Seconds)</td><td>Integer
395
395
- Default Value: 360</td><td>The maximum age of the measurement to use</td></tr><tr><td>Measurement C</td><td>Select Measurement (Input, Function)</td><td>Measurement to replace C</td></tr><tr><td>Measurement C: Max Age (Seconds)</td><td>Integer
396
396
- Default Value: 360</td><td>The maximum age of the measurement to use</td></tr></tbody></table>
Copy file name to clipboardExpand all lines: docs/Supported-Inputs.md
+33-4
Original file line number
Diff line number
Diff line change
@@ -873,7 +873,7 @@ A single topic is subscribed to and the returned JSON payload contains one or mo
873
873
- Default Value: 1883</td><td>Host port number</td></tr><tr><td>Topic</td><td>Text
874
874
- Default Value: mqtt/test/input</td><td>The topic to subscribe to</td></tr><tr><td>Keep Alive</td><td>Integer
875
875
- Default Value: 60</td><td>Maximum amount of time between received signals. Set to 0 to disable.</td></tr><tr><td>Client ID</td><td>Text
876
-
- Default Value: client_FGIg092m</td><td>Unique client ID for connecting to the server</td></tr><tr><td>Use Login</td><td>Boolean</td><td>Send login credentials</td></tr><tr><td>Use TLS</td><td>Boolean</td><td>Send login credentials using TLS</td></tr><tr><td>Username</td><td>Text
876
+
- Default Value: client_qty5tMmS</td><td>Unique client ID for connecting to the server</td></tr><tr><td>Use Login</td><td>Boolean</td><td>Send login credentials</td></tr><tr><td>Use TLS</td><td>Boolean</td><td>Send login credentials using TLS</td></tr><tr><td>Username</td><td>Text
877
877
- Default Value: user</td><td>Username for connecting to the server</td></tr><tr><td>Password</td><td>Text</td><td>Password for connecting to the server. Leave blank to disable.</td></tr><tr><td>Use Websockets</td><td>Boolean</td><td>Use websockets to connect to the server.</td></tr><tr><tdcolspan="3">Channel Options</td></tr><tr><td>Name</td><td>Text</td><td>A name to distinguish this from others</td></tr><tr><td>JMESPATH Expression</td><td>Text</td><td>JMESPATH expression to find value in JSON response</td></tr></tbody></table>
878
878
879
879
### MQTT: MQTT Subscribe (Value payload)
@@ -889,7 +889,7 @@ A topic is subscribed to for each channel Subscription Topic and the returned pa
889
889
- Default Value: localhost</td><td>Host or IP address</td></tr><tr><td>Port</td><td>Integer
890
890
- Default Value: 1883</td><td>Host port number</td></tr><tr><td>Keep Alive</td><td>Integer
891
891
- Default Value: 60</td><td>Maximum amount of time between received signals. Set to 0 to disable.</td></tr><tr><td>Client ID</td><td>Text
892
-
- Default Value: client_mqUgXLvM</td><td>Unique client ID for connecting to the server</td></tr><tr><td>Use Login</td><td>Boolean</td><td>Send login credentials</td></tr><tr><td>Use TLS</td><td>Boolean</td><td>Send login credentials using TLS</td></tr><tr><td>Username</td><td>Text
892
+
- Default Value: client_2NluwVOT</td><td>Unique client ID for connecting to the server</td></tr><tr><td>Use Login</td><td>Boolean</td><td>Send login credentials</td></tr><tr><td>Use TLS</td><td>Boolean</td><td>Send login credentials using TLS</td></tr><tr><td>Username</td><td>Text
893
893
- Default Value: user</td><td>Username for connecting to the server</td></tr><tr><td>Password</td><td>Text</td><td>Password for connecting to the server. Leave blank to disable.</td></tr><tr><td>Use Websockets</td><td>Boolean</td><td>Use websockets to connect to the server.</td></tr><tr><tdcolspan="3">Channel Options</td></tr><tr><td>Name</td><td>Text</td><td>A name to distinguish this from others</td></tr><tr><td>Subscription Topic</td><td>Text</td><td>The MQTT topic to subscribe to</td></tr></tbody></table>
894
894
895
895
### Melexis: MLX90393
@@ -999,7 +999,7 @@ A topic is subscribed to for each channel Subscription Topic and the returned pa
<table><thead><trclass="header"><th>Option</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>I<sup>2</sup>C Address</td><td>Text</td><td>The address of the I<sup>2</sup>C device.</td></tr><tr><td>I<sup>2</sup>C Bus</td><td>Integer</td><td>The Bus the I<sup>2</sup>C device is connected.</td></tr><tr><td>Measurements Enabled</td><td>Multi-Select</td><td>The measurements to record</td></tr><tr><td>Period (Seconds)</td><td>Decimal</td><td>The duration between measurements or actions</td></tr><tr><td>Pre Output</td><td>Select</td><td>Turn the selected output on before taking every measurement</td></tr><tr><td>Pre Out Duration (Seconds)</td><td>Decimal</td><td>If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired.</td></tr><tr><td>Pre During Measure</td><td>Boolean</td><td>Check to turn the output off after (opposed to before) the measurement is complete</td></tr></tbody></table>
1001
1001
1002
-
### Power Monitor: RPi Power Monitor (6 Channels)
1002
+
### Power Monitor: RPi 6-Channel Power Monitor (v0.1.0)
1003
1003
1004
1004
- Manufacturer: Power Monitor
1005
1005
- Measurements: AC Voltage, Power, Current, Power Factor
@@ -1026,6 +1026,35 @@ See https://github.com/David00/rpi-power-monitor/wiki/Calibrating-for-Accuracy f
1026
1026
- Default Value: 1.0</td><td>The accuracy calibration value for CT6</td></tr><tr><td>AC Accuracy Calibration</td><td>Decimal
1027
1027
- Default Value: 1.0</td><td>The accuracy calibration value for AC</td></tr></tbody></table>
1028
1028
1029
+
### Power Monitor: RPi 6-Channel Power Monitor (v0.4.0)
1030
+
1031
+
- Manufacturer: Power Monitor
1032
+
- Measurements: AC Voltage, Power, Energy, Current, Power Factor
See https://david00.github.io/rpi-power-monitor/docs/v0.3.0/calibration.html for calibration documentation.
1039
+
<table><thead><trclass="header"><th>Option</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Measurements Enabled</td><td>Multi-Select</td><td>The measurements to record</td></tr><tr><td>Period (Seconds)</td><td>Decimal</td><td>The duration between measurements or actions</td></tr><tr><td>Pre Output</td><td>Select</td><td>Turn the selected output on before taking every measurement</td></tr><tr><td>Pre Out Duration (Seconds)</td><td>Decimal</td><td>If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired.</td></tr><tr><td>Pre During Measure</td><td>Boolean</td><td>Check to turn the output off after (opposed to before) the measurement is complete</td></tr><tr><td>Period (Seconds) for kWh Measuring</td><td>Integer
1040
+
- Default Value: 5</td><td>How often to acquire measurements to calculate kWh</td></tr><tr><td>Grid Voltage</td><td>Decimal
1041
+
- Default Value: 124.2</td><td>The AC voltage measured at the outlet</td></tr><tr><td>Transformer Voltage</td><td>Decimal
1042
+
- Default Value: 10.2</td><td>The AC voltage measured at the barrel plug of the 9 VAC transformer</td></tr><tr><td>AC Frequency (Hz)</td><td>Integer
1043
+
- Default Value: 60</td><td>The frequency of the AC voltage</td></tr><tr><td>CT1 Calibration</td><td>Decimal
1044
+
- Default Value: 1.0</td><td>The calibration value for CT1</td></tr><tr><td>CT1 Rating</td><td>Decimal
1045
+
- Default Value: 100</td><td>The Amp rating for the CT1 clamp</td></tr><tr><td>CT2 Calibration</td><td>Decimal
1046
+
- Default Value: 1.0</td><td>The calibration value for CT2</td></tr><tr><td>CT2 Rating</td><td>Decimal
1047
+
- Default Value: 100</td><td>The Amp rating for the CT2 clamp</td></tr><tr><td>CT3 Calibration</td><td>Decimal
1048
+
- Default Value: 1.0</td><td>The calibration value for CT3</td></tr><tr><td>CT3 Rating</td><td>Decimal
1049
+
- Default Value: 100</td><td>The Amp rating for the CT3 clamp</td></tr><tr><td>CT4 Calibration</td><td>Decimal
1050
+
- Default Value: 1.0</td><td>The calibration value for CT4</td></tr><tr><td>CT4 Rating</td><td>Decimal
1051
+
- Default Value: 100</td><td>The Amp rating for the CT4 clamp</td></tr><tr><td>CT5 Calibration</td><td>Decimal
1052
+
- Default Value: 1.0</td><td>The calibration value for CT5</td></tr><tr><td>CT5 Rating</td><td>Decimal
1053
+
- Default Value: 100</td><td>The Amp rating for the CT5 clamp</td></tr><tr><td>CT6 Calibration</td><td>Decimal
1054
+
- Default Value: 1.0</td><td>The calibration value for CT6</td></tr><tr><td>CT6 Rating</td><td>Decimal
1055
+
- Default Value: 100</td><td>The Amp rating for the CT6 clamp</td></tr><tr><td>AC Calibration</td><td>Decimal
1056
+
- Default Value: 1.0</td><td>The calibration value for AC</td></tr><tr><tdcolspan="3">Commands</td></tr><tr><tdcolspan="3">Clear the running kWh totals.</td></tr><tr><td>Channel to Clear</td><td>Select(Options: [All Channels | <strong>Channel 1</strong> | Channel 2 | Channel 3 | Channel 4 | Channel 5 | Channel 6] (Default in <strong>bold</strong>)</td><td>The channel(s) to clear the kWh total and start back at 0.</td></tr><tr><td>Clear kWh Total</td><td>Button</td><td></td></tr></tbody></table>
1057
+
1029
1058
### ROHM: BH1750
1030
1059
1031
1060
- Manufacturer: ROHM
@@ -1339,7 +1368,7 @@ This Input module allows the use of any temperature/humidity sensor with the TH1
1339
1368
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.
1340
1369
<table><thead><trclass="header"><th>Option</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Measurements Enabled</td><td>Multi-Select</td><td>The measurements to record</td></tr><tr><td>Period (Seconds)</td><td>Decimal</td><td>The duration between measurements or actions</td></tr><tr><td>Pre Output</td><td>Select</td><td>Turn the selected output on before taking every measurement</td></tr><tr><td>Pre Out Duration (Seconds)</td><td>Decimal</td><td>If a Pre Output is selected, set the duration to turn the Pre Output on for before every measurement is acquired.</td></tr><tr><td>Pre During Measure</td><td>Boolean</td><td>Check to turn the output off after (opposed to before) the measurement is complete</td></tr><tr><td>Device Type</td><td>Select</td><td>The type of Kasa device</td></tr><tr><td>Host</td><td>Text
1341
1370
- Default Value: 0.0.0.0</td><td>Host or IP address</td></tr><tr><td>Asyncio RPC Port</td><td>Integer
1342
-
- Default Value: 18108</td><td>The port to start the asyncio RPC server. Must be unique from other Kasa Outputs.</td></tr><tr><tdcolspan="3">Commands</td></tr><tr><tdcolspan="3">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.</td></tr><tr><td>Clear Total: Kilowatt-hour</td><td>Button</td><td></td></tr></tbody></table>
1371
+
- Default Value: 18752</td><td>The port to start the asyncio RPC server. Must be unique from other Kasa Outputs.</td></tr><tr><tdcolspan="3">Commands</td></tr><tr><tdcolspan="3">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.</td></tr><tr><td>Clear Total: Kilowatt-hour</td><td>Button</td><td></td></tr></tbody></table>
0 commit comments