Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Commands for sensor100 INA3221.md #1382

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update Commands for sensor100 INA3221.md #1382

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
035416c
Update Commands.md
fb-pilot Apr 26, 2024
2295953
Update Commands.md
fb-pilot Apr 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/Commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,8 @@ Sensor80<a class="cmnd" id="sensor80"></a>|Set antenna gain for MFRC522 RFID Rea
Sensor90<a class="cmnd" id="sensor90"></a>|Send [commands](https://rainsensors.com/wp-content/uploads/sites/3/2020/07/rg-15_instructions_sw_1.000.pdf) to Hydreon RG-15 Rain Sensor<BR>`A` Reads accumulation data<BR>`R` Read all available data<BR>`K` Restart the rain sensor<BR>`P` Set to polling only mode (not supported)<BR>`C` Set to continuous mode, where data is sent when accumulation changes (default)<BR>`H` Force high resolution<BR>`L` Force low resolution<BR>`I` Force imperial (not supported)<BR>`M` Force metric (default)<BR>`S` Revert to jumper configured values<BR>`O` Reset the accumulation counter
Sensor95<a class="cmnd" id="Sensor95"></a>|CM110x automatic baseline correction, 1=enable (default), 0=disable
Sensor96<a class="cmnd" id="Sensor96"></a>|USE_FLOWRATEMETER settings
Sensor100<a class="cmnd" id="sensor100"></a>|INA3221 3-channel Voltage and Current Sensor<BR>`<deviceId>`: with `<deviceId>`=1..4 : display current shunt resistor values in ohm for the given device index (up to 4x INA3221 devices)<BR>`<device>, <shuntChan1>, <shuntChan2>, <shuntChan3>`: set the shunt resistor values in ohm for the 3 channels of the given device index. <BR>A value of 0 means the channel is disabled and won't be displayed in the UI. A disabled channel is reported with value`null` in the SENSOR JSON<BR>Exemple:<BR>`Sensor100 1, 0.1, 0.1, 0.1` set all 3 shunts to the value 0.1 ohms and enable all 3 channels on the 1st INA3221 device.<BR>WARNING: Shunt values are NOT saved in flash settings. They must be re-configured at boot using `autoexec.bat` (if there is a filesystem) or a boot rule such as:<BR>`Rule1 on system#init do Sensor100 1, 0.1, 0.1, 0.1 endon`
Sensor100<a class="cmnd" id="sensor100"></a>|INA3221 3-channel Voltage and Current Sensor<BR>`<deviceId>`: with `<deviceId>`=1..4 : display current shunt resistor values in ohm for the given device index (up to 4x INA3221 devices)<BR>`<device>, <shuntChan1>, <shuntChan2>, <shuntChan3>`: set the shunt resistor values in ohm for the 3 channels of the given device index. <BR>A value of 0 means the channel is disabled and won't be displayed in the UI. A disabled channel is reported with value`null` in the SENSOR JSON<BR>Exemple:<BR>`Sensor100 1, 0.1, 0.1, 0.1` set all 3 shunts to the value 0.1 ohms and enable all 3 channels on the 1st INA3221 device.<BR>WARNING: Shunt values are NOT saved in flash settings. They must be re-configured at boot using `autoexec.bat` (if there is a filesystem) or a boot rule such as:<BR>`Rule1 on system#init do Sensor100 1, 0.1, 0.1, 0.1 endon`<BR>By defining `INA3221_CALC_CHARGE_AH / INA3221_CALC_ENERGY_WH` the driver adds a estimation of charge/energy in Ah and Wh to the output, To reset the energie calculation disable the according INA3221 chanel by setting the shunt to 0.0 and enable it again<BR> For example : `sensor100 1,0,0.1,0.2` (or `sensor100 1,,,`) and `sensor100 1,0.1,0.1,0.2` will reset channel 1 of device 1<BR>By defining `INA3221_SUPPLY_SIDE` the driver adds the measured shunt-voltage to the bus-voltage for the cannel with a negativ shunt-value (shunt <0) thus showing the values of the supply side (IN+) otherwise (shunt >0) the load-side (IN-) is shown.<BR> e.g. `sensor100 1,-0.1,0.1,-0.2` shows the supply-voltage of channel 1 and 3.<BR> additionaly the bits set (bit 0,1,2) enable the scanning of the voltage in the according channel thus you influence the scanning of the INA3221 chip (bus voltage, shunt-voltage or both)<BR> e.g. `INA3221_SUPPLY_SIDE 0x0005` enables voltage-measurment of channel 1 and 3 for the device 1

SpeedUnit<a class="cmnd" id="SpeedUnit"></a>|[TX20/TX23](TX2x) and WindMeter anemometer speed unit<BR>`1` = m/s<BR>`2`= km/h<BR>`3` = kn<br>`4` = mph<BR>`5` = ft/s<BR>`6` = yd/s
TempRes<a class="cmnd" id="tempres"></a>|Temperature sensor resolution<BR>`0..3` = maximum number of decimal places
TempOffset<a class="cmnd" id="tempoffset"></a>|`-12.6..12.6` = Set calibration offset value for reported temperature telemetry<BR>This setting affects **all** temperature sensors on the device.
Expand Down