Skip to content

Latest commit

 

History

History
3582 lines (2658 loc) · 77.2 KB

commands.md

File metadata and controls

3582 lines (2658 loc) · 77.2 KB
Raw

Fanpico: Command Reference

Fanpico uses "SCPI like" command set. Command syntax should be mostly SCPI and IEE488.2 compliant, to make it easier to control and configure Fanpico units.

Command Set

Fanpico supports following commands:

Additionally unit will respond to following standard SCPI commands to provide compatibility in case some program unconditionally will send these:

  • *CLS
  • *ESE
  • *ESE?
  • *ESR?
  • *OPC
  • *OPC?
  • *SRE
  • *SRE?
  • *STB?
  • *TST?
  • *WAI

Common Commands

*IDN?

Identify device. This returns string that contains following fields:

<manufacturer>,<model number>,<serial number>,<firmware version>

Example:

*IDN?
TJKO Industries,FANPICO-0804,e660c0d1c768a330,1.0

*RST

Reset unit. This triggers Fanpico to perform (warm) reboot.

*RST

CONFigure:

Commands for configuring the device settings.

CONFigure?

Display current configuration in JSON format. Same as CONFigure:Read?

Example:

CONF?

CONFigure:SAVe

Save current configuration into flash memory.

Example:

CONF:SAVE

CONFigure:Read?

Display current configuration in JSON format.

Example:

CONF:READ?

CONFigure:DELete

Delete current configuration saved into flash. After unit has been reset it will be using default configuration.

Example:

CONF:DEL
*RST

CONFigure:FANx Commands

FANx commands are used to configure specific fan output port. Where x is a number from 1 to 8.

For example:

CONFIGURE:FAN8:NAME Exhaust Fan 2

CONFigure:FANx:NAME

Set name for fan (output) port.

For example:

CONF:FAN1:NAME CPU Fan 1

CONFigure:FANx:NAME?

Query name of a fan (output) port.

For example:

CONF:FAN1:NAME?
CPU Fan 1

CONFigure:FANx:HYSTeresis:TACho

new: release v1.6.4
Set the hysteresis threshold for a given tacho fan (output) port.

For example:

CONF:FAN1:HYST:TACHO 1.5

CONFigure:FANx:HYSTeresis:TACho?

new: release v1.6.4
Query the hysteresis threshold for a given tacho fan (output) port.

For example:

CONF:FAN1:HYST:TACHO?
1.500000

CONFigure:FANx:HYSTeresis:PWM

new: release v1.6.4
Set the hysteresis threshold for a given tacho PWM (output) port.

For example:

CONF:FAN1:HYST:PWM 2.0

CONFigure:FANx:HYSTereris:PWM?

new: release v1.6.4
Query the hysteresis threshold for a given PWM fan (output) port.

For example:

CONF:FAN1:HYST:PWM?
2.000000

CONFigure:FANx:MINpwm

Set absolute minimum PWM duty cycle (%) for given fan port. This can be used to make sure that fan always sees a minimum duty cycle (overriding the normal fan signal).

Default: 0 %

Example: Set minimum PWM duty cycle to 20% for FAN1

CONF:FAN1:MIN 20

CONFigure:FANx:MINpwm?

Query current minimum PWM duty cycle (%) configured on a fan port.

Example:

CONF:FAN1:MIN?
20

CONFigure:FANx:MAXpwm

Set absolute maximum PWM duty cycle (%) for given fan port. This can be used to make sure that fan never sees higher duty cycle than given value (overriding the normal fan signal).

Default: 100 %

Example: Set maximum PWM duty cycle to 95% for FAN1

CONF:FAN1:MAX 95

CONFigure:FANx:MAXpwm?

Query current maximum PWM duty cycle (%) configured on a fan port.

Example:

CONF:FAN1:MAX?
95

CONFigure:FANx:PWMCoeff

Set scaling factor for the fan PWM (output) signal. This is applied to the PWM duty cycle before MAXpwm and MINpwm limits are applied.

Default: 1.0

Example: Set FAN6 to run 20% slower than signal its configured to follow.

CONF:FAN6:PWMC 0.8

CONFigure:FANx:PWMCoeff?

Query current PWM duty cycle (%) scaling factor configured on a fan port.

Example:

CONF:FAN6:PWMC?
0.8

CONFigure:FANx:RPMFactor

Set number of pulses fan generates per one revolution. This is used to calculate RPM measurement based on the Tachometer signal from the fan.

PC Fans typically send 2 pulses per revolution (per Intel specifications).

Default: 2

Example: Adjust factor for a fan that produces 4 pulses per revolution

CONF:FAN1:RPMF 4

CONFigure:FANx:RPMFactor?

Query current RPM conversion factor configured on a fan port.

Example:

CONF:FAN1:RPMF?
4

CONFigure:FANx:RPMMOde

Configure what type tachometer signal fan is sending.

Supported signal types:

Signal Type Setting Notes
Tachometer TACHO Fan is sending normal tachometer pulses to indicate rotation speed.
Locked Rotor (Alarm) LRA,low_rpm,high_rpm Parameters indicate mapping from LRA to RPM speeds (corresponding to LOW and HIGH signal received from the fan).

Default: TACHO (fan sends standard tachometer pulses to indicate rotation speed)

Example: Fan is not sending tachometer signal but Locked Rotor Alam signal (LRA) on tachometer pin (we map HIGH signal to mean 0 RPM and LOW signal to mean 2000 RPM)

CONF:FAN1:RPMMODE LRA,2000,0

Example: Fan is sending Locked Rotor (Alarm) signal (LRA), where polarity in reversed (LOW signal indicates lockup/failure):

CONF:FAN2:RPMMODE LRA,0,2000

CONFigure:FANx:RPMMOde?

Query current RPM tachometer signal settings for a fan.

Example:

CONF:FAN1:RPMMODE?
TACHO
CONF:FAN2:RPMMODE?
LRA,0,2000

CONFigure:FANx:SOUrce

Configure source for the PWM signal of a fan.

Source types:

  • MBFAN (set fan to follow duty cycle from motherboard fan port)
  • SENSOR (set fan to follow temperature based duty cycle)
  • VSENSOR (set fan to follow temperature based duty cycle)
  • FAN (set fan to follow another FAN output duty cycle)
  • FIXED (set fan to run on fixed duty cycle)

Defaults:

FAN SOURCE
1 MBFAN,1
2 MBFAN,2
3 MBFAN,3
4 MBFAN,4
5 MBFAN,1
6 MBFAN,2
7 MBFAN,3
8 MBFAN,4

Example: Set FAN 5 to follow temperature sensor 2

CONF:FAN5:SOURCE SENSOR,2

Example: Set FAN 6 to run always at fixed 50% duty cycle (speed)

CONF:FAN6:SOURCE FIXED,50

CONFigure:FANx:SOUrce?

Query current signal source for a fan.

Command returns response in following format:

source_type,source_no

Example:

CONF:FAN1:SOU?
mbfan,1

CONFigure:FANx:PWMMap

Set mapping (curve) for the PWM duty cycle signal. This can be used to customize how fan will respond to input signal it receives.

Mapping is specified with up to 32 points (that can be plotted as a curve) that map the relation of the input signal (x value) to output signal (y value). Mapping should at minimum include that start and end points of the expected input signal (typically 0 and 100).

Default mapping is linear (1:1) mapping:

x y
0 0
100 100

Example: Configure Fan to run at 20% duty cycle between 0-20% input signal then scale linearly to 100% by the time input signal reaches 100%

CONF:FAN1:PWMMAP 0,20,20,20,100,100

Example: Assuming we have "fancy" PWM fan that actually stops spinning on 0% duty cycle. And we want fan not run until input PWM signal duty cycle is over 30%, and we want fan to reach full speed by the time 90% duty signal is received.

CONF:FAN1:PWMMAP 0,0,30,0,90,100

CONFigure:FANx:PWMMap?

Display currently active mapping (curve) for the PWM duty signal.

Mapping is displayed as comma separated list of values:

x_1,y_1,x_2,y_2,...,x_n,y_n

For example:

CONF:FAN1:PWMMAP?
0,0,100,100

CONFigure:FANx:FILTER

Configure filter to be applied for the PWM signal controlling the fan.

Filter Description Arguments Argument Descriptions Example Notes
none No Filter
lossypeak Lossy Peak Detector decay_rate,decay_start_delay * decay rate [points per second] (valid values: > 0.0)
* decay start delay [seconds] (valid values: >= 0.0)		 CONF:FAN1:FILTER lossypeak,1.5,15 This can be useful for smoothing out erratic (CPU Fan) PWM signal from motherboard.
sma Simple Moving Average window_size * window size [points] (valid range: 2..32)
 CONF:FAN1:FILTER sma,10 This can be useful for filtering temperature sensor signal.

For example:

CONF:FAN1:FILTER lossypeak,1.0,30

CONFigure:FANx:FILTER?

Display currently active (PWM) filter for the fan.

Format: filter,arg_1,arg_2,...arg_n

For example:

CONF:FAN1:FILTER?
lossypeak,1.0,30.0

CONFigure:MBFANx Commands

MBFANx commands are used to configure specific motherboard fan input port. Where x is a number from 1 to 4.

For example:

CONF:MBFAN4:NAME Water Pump

CONFigure:MBFANx:NAME

Set name for motherboard fan (input) port.

For example:

CONF:MBFAN1:NAME CPU Fan

CONFigure:MBFANx:NAME?

Query name of a motherboard fan (input) port.

For example:

CONF:MBFAN1:NAME?
CPU Fan

CONFigure:MBFANx:MINrpm

Set absolute minimum RPM value for given motherboard fan port. This can be used to make sure motherboard never sees "fan" running slower than this value (even if fan is not running at all).

Default: 0

Example: Set minimum RPM (sent to motheboard) to be at least 500

CONF:MBFAN1:MIN 500

CONFigure:MBFANx:MINrpm?

Query current minimum RPM value configured on a motherboard fan port.

Example:

CONF:MBFAN1:MIN?
500

CONFigure:MBFANx:MAXrpm

Set absolute maximum value for given motherboard fan port. This can be used to make sure motherboard never sees "fan" running ffaster than this value.

Default: 10000

Example: Set maximum RPM value motheboard can see to 3000

CONF:MBFAN1:MAX 3000

CONFigure:MBFANx:MAXrpm?

Query current maximum RPM value configured on a motherboard fan port.

Example:

CONF:MBFAN1:MAX?
3000

CONFigure:MBFANx:RPMCoeff

Set scaling factor for the motherboard fan Tachometer (output) signal. This is applied to adjust the output RPM (and tachometer signal frequency).

Default: 1.0

Example: Scale the MBFAN4 port Tachometer (RPM) values to be 20% higher than input.

CONF:MBFAN4:RPMC 1.2

CONFigure:MBFANx:RPMCoeff?

Query current TAchometer (RPM) scaling factor configured on a motherboard fan port.

Example:

CONF:MBFAN6:RPMC?
1.2

CONFigure:MBFANx:RPMFactor

Set number of pulses per one revolution in the generated tachometer signal (going out to motherboard). This is mainly only needed if using Fanpico with something else than PC motherboard, that expects to see tachometer signal from Fans that produce other than the default 2 pulses per revolution.

Default: 2

Example: Adjust factor for (emulating fan that produces 4 pulses per revolution

CONF:MBFAN1:RPMF 4

CONFigure:MBFANx:RPMFactor?

Query current RPM conversion factor configured on a motherboard fan port.

Example:

CONF:MBFAN1:RPMF?
4

CONFigure:MBFANx:RPMMOde

Configure what type tachometer signal is sent (out) to motherboard.

Supported signal types:

Signal Type Setting Notes
Tachometer TACHO Send normal tachometer pulses to indicate rotation speed.
Locked Rotor (Alarm) LRA,treshold_rpm,locked_signal_level Send Locked Rotor Alarm signal, when RPM is below treshold RPM speed send the indicated signal (HIGH or LOW).

NOTE! When changing RPM Mode for a mbfan (output), system must be reset before change takes effect.

Default: TACHO (standard tachometer pulses to indicate rotation speed)

Example: Send 'HIGH' Locked Rotor (Alarm) signal (when RPM drops below 200 RPM)

CONF:MBFAN1:RPMMODE LRA,200,HIGH

Example: Send 'LOW' Locked Rotor (Alarm) signal (when RPM drops below 500 RPM)

CONF:MBFAN2:RPMMODE LRA,500,LOW

CONFigure:FANx:RPMMOde?

Query current RPM tachometer signal settings for a fan.

Example:

CONF:FAN1:RPMMODE?
TACHO
CONF:FAN2:RPMMODE?
LRA,0,2000

CONFigure:MBFANx:SOUrce

Configure source for the Tachometer (RPM) signal for a motheboard fan (output) port.

Source types:

Type Parameters Description Example
FAN n Return tachometer signal of a specified fan FAN,1
FIXED rpm Return static tachometer signal at specified rpm FIXED,1500
MIN n1,n2,... Return slowest FAN speed acros specified fans MIN,2,7,8
MAX n1,n2,... Return fastest FAN speed acros specified fans MAX,2,7,8
AVG n1,n2,... Return average FAN speed acros specified fans AVG,2,7,8

Defaults:

MBFAN SOURCE
1 FAN,1
2 FAN,2
3 FAN,3
4 FAN,4

Example: Set MBFAN 2 to follow Tachometer signal from FAN8

CONF:MBFAN2:SOURCE FAN,8

Example: Set MBFAN 4 to see fixed 1500 RPM tachometer signal

CONF:MBFAN4:SOURCE FIXED,1500

Example: Set MBFAN 1 to return slowest fan speed from FAN1, FAN2, and FAN3

CONF:MBFAN1:SOURCE MIN,1,2,3

CONFigure:MBFANx:SOUrce?

Query current signal source for a motherboar fan (Tachometer output).

Command returns response in following format:

source_type,source_no

Example:

CONF:MBFAN1:SOU?
fan,1

CONFigure:MBFANx:RPMMap

Set mapping (curve) for the Tachometer (RPM) output signal to motherboard. This can be used to customize what motherboard sees as the "fan" RPM.

Mapping is specified with up to 32 points (that can be plotted as a curve) that map the relation of the input signal (x value) to output signal (y value). Mapping should at minimum include that start and end points of the expected input signal (typically 0 and 100).

Default mapping is linear (1:1) mapping:

x y
0 0
10000 10000

Example: Assuming we have configured FAN1 to only run above 30% PWM signal, but our motherboard sets alarm when it doesn't detect fan running, we can provide 'fake' 500RPM speed to the motherboard until fan is actually running at least 500 RPM...

CONF:MBFAN1:RPMMAP 0,500,500,500,10000,10000

CONFigure:MBFANx:RPMMap?

Display currently active mapping (curve) for the tachometer signal sent to motherboard fan port.

Mapping is displayed as comma separated list of values:

x_1,y_1,x_2,y_2,...,x_n,y_n

For example:

CONF:MBFAN1:RPMMAP?
0,0,10000,10000

CONFigure:MBFANx:FILTER

Configure filter to be applied to the PWM signal received (from motheboard, etc.)

List of available filters can be found here: Available Filters

By default, no filter is applied (filter is set to "none").

Example: Set filter for the input signal to "Lossy Peak Detector", that is often useful with erratic PWM signals (like CPU Fan control signal on many motherboards).

CONF:MBFAN1:FILTER lossypeak,1.5,10

CONFigure:MBFANx:FILTER?

Display currently active filter for the input PWM signal.

Format: filter,arg_1,arg_2,...arg_n

For example:

CONF:MBFAN1:FILTER?
none,

CONFigure:SENSORx Commands

SENSORx commands are used to configure specific (temperature) sensor. Where x is a number from 1 to 3.

Sensor Description
1 Thermistor connected to SENSOR1 connector.
2 Thermistor connected to SENSOR2 connector.
3 Internal temperature sensor on RP2040 (can be used for "Ambient" temperature measurementes as RP2040 doesn't heat up significantly).

For example:

CONF:SENSOR1:NAME Air Intake

CONFigure:SENSORx:NAME

Set name for temperature sensor.

For example:

CONF:SENSOR1:NAME Air Intake

CONFigure:SENSORx:NAME?

Query name of a temperature sensor.

For example:

CONF:SENSOR1:NAME?
Air Intake

CONFigure:SENSORx:TEMPOffset

Set offset that is applied to measured temperature. This can be used as a grude calibration method by setting offset to the difference of actual temperature vs. what sensor is reporting.

Default: 0.0

For example: Sensor is reporting 2.5 degrees "high", so set offset to -2.5:

CONF:SENSOR1:TEMPO -2.5

CONFigure:SENSORx:TEMPOffset?

Get the current temperature offset configured for the sensor.

For example:

CONF:SENSOR1:TEMPO?
-2.5

CONFigure:SENSORx:TEMPCoeff

Set coefficient that is used to multiply the (raw) temperature sensor reports. This can be used to correct error in temperature measurements.

Default: 1.0

For example: Sensor is consistently reading 10% higher than actual temperature

CONF:SENSOR1:TEMPC 0.9

CONFigure:SENSORx:TEMPCoeff?

Get the current temperature coefficient configured for the sensor.

For example:

CONF:SENSOR1:TEMPC?
0.9

CONFigure:SENSORx:TEMPMap

Set mapping (curve) for converting temperature to PWM signal duty cycle (%). This can be used to customize how temperature affects fan speed.

Mapping is specified with up to 32 points (that can be plotted as a curve) that map the relation of the temperature (x value) to output PWM signal (y value). Mapping should at minimum include that start and end points of the expected input signal.

Default mapping:

x (Temperature in C) y (Fan Duty Cycle in %)
20 0
50 100

Example: Set Fan to start running at 20% duty cycle at 25C and to be full speed at 50C

CONF:SENSOR1:TEMPMAP 25,20,50,100

CONFigure:SENSORx:TEMPMap?

Display currently active mapping (curve) for convertin measured temperature to PWM duty cycle (%) for the fan output signal.

Mapping is displayed as comma separated list of values:

x_1,y_1,x_2,y_2,...,x_n,y_n

For example:

CONF:SENSOR1:TEMPMAP?
20,0,50,10000

CONFigure:SENSORx:BETAcoeff

Set beta coefficient of thermistor used to measure temperature. Typically thermistor beta coefficient is in the range 3000-4000.

Default: 3950

For example:

CONF:SENSOR1:BETA 3950

CONFigure:SENSORx:BETAcoeff?

Get the configured beta coefficient of the thermistor used to measure temperature.

For example:

CONF:SENSOR1:BETA?
3950

CONFigure:SENSORx:THERmistor

Set thermistor nominal resistance at nominal (room) temperature. Typically this is either 10000 (for 10k thermistors) or 100000 (for 100k thermistors).

Default: 10000

For example: configure 100k thermistor

CONF:SENSOR1:THER 100000

CONFigure:SENSORx:THERmistor?

Get the thermistor nominal resistance at nominal (room) temperature.

For example:

CONF:SENSOR1:THER?
100000

CONFigure:SENSORx:TEMPNominal

Set nominal temperature of the thermistor (in C). Typically nominal temperature is around room temperature.

Default: 25.0

For example:

CONF:SENSOR1:TEMPN 25.0

CONFigure:SENSORx:TEMPNominal?

Get nominal temperature of the thermistor (in C).

For example:

CONF:SENSOR1:TEMPN?
25.0

CONFigure:SENSORx:FILTER

Configure filter to be applied to the temperature signal received from the sensor.

List of available filters can be found here: Available Filters

By default, no filter is applied (filter is set to "none").

Example: Set filter for the input signal to "Simple Moving Average", that can be useful with noisy readings from temperature sensors.

CONF:SENSOR1:FILTER sma,10

CONFigure:SENSORx:FILTER?

Display currently active filter for the temperature signal received from the sensor.

Format: filter,arg_1,arg_2,...arg_n

For example:

CONF:SENSOR1:FILTER?
sma,10

CONFigure:VSENSORS?

This is same as CONFigure::VSENSORS:SOUrces? command.

CONFigure:VSENSORS:SOUrces?

Return virtual sensor (source) configuration information for all virtual sensors in CSV format.

Format: ,,,,...

Example:

CONF:VSENSORS:SOURCES?
vsensor1,onewire,22cd991800000020
vsensor2,i2c,0x48,TMP117
vsensor3,i2c,0x37,PCT2075
vsensor4,i2c,0x77,DPS310
vsensor5,i2c,0x76,BMP280
vsensor6,i2c,0x49,ADT7410
vsensor7,i2c,0x38,AHT2x
vsensor8,manual,0.00,30

CONFigure:VSENSORx Commands

VSENSORx (where x is the sensor number) commands are used to configure virtual temperature sensors. These can be "sensors" that are updated by software, like "CPU Temperature" of host system. Or these can be be virtual sensors that report value of multiple physical sensors fed through a mathematical formula.

Where x is a number from 1 to 8.

Virtual Sensor Mode Description
manual Manually updated (by software) sensor values. For example host CPU Temperature.
max Maximum temperature of configured source sensors.
min Minimum temperature of configured source sensors.
avg Average temperature of configured source sensors.
delta Temperature delta between readings from two source sensors.
onewire Reading from digital 1-Wire sensor

CONFigure:VSENSORx:NAME

Set name for virtual temperature sensor.

For example:

CONF:VSENSOR1:NAME CPU Temperature

CONFigure:VSENSORx:NAME?

Query name of a virtual temperature sensor.

For example:

CONF:VSENSOR1:NAME?
CPU Temperature

CONFigure:VSENSORx:SOUrce

Configure source for the virtual temperature sensor.

Source types:

MODE Description No of Parameters Parameters
MANUAL Temperature updated by external program/driver 2 default_temperature_C,timeout
MAX Maximum temperatore between source sensors 2+ sensor_a,sensor_b, ...
MIN Minimum temperature between source sensors 2+ sensor_a,sensor_b, ...
AVG Average temperature between source sensors 2+ sensor_a,sensor_b, ...
DELTA Temperature delta between to source sensors 2 sensor_a,sensor_b
ONEWIRE Temperature reading from digital 1-Wire sensor 1 onewire_address
I2C Temperature reading from digital I2C sensor 2 i2c_address,sensor_model

Note, in "manual" mode if timeout_ms is set to zero, then sensor's temperature reading will never revert back to default value (if no updates are being received).

Sensor numbering:

  • SENSORS: 1, 2, ...
  • VSENSORS: 101, 102, ...

Supporte I2C sensors:

Sensor Model Possible Addresses Description Notes
ADT7410 0x48, 0x49, 0x4a, 0x4b 16bit, 0.5C accuracy
AHT1x AHT1x (AHT10, AHT11 ,...)
AHT2x AHT2x (AHT20, AHT21 ,...)
AS621x AS621x series: AS6212 (0.2C), AC6214 (0.4C), AC6218 (0.8C)
BMP180 16bit, 0.5C accuracy
BMP280 0x76, 0x77 20bit, 0.5C accuracy
DPS310 0x77, 0x76 24bit, 0.5C accuracy
LPS22 0x5d, 0x5c Temperature and Pressure sensor
LPS25 0x5d, 0x5c Temperature and Pressure sensor, 2C accuracy
MCP9808 13bit, 0.25C accuracy
MS8607 0x77 Temperature, Humidity and Pressure Sensor
PCT2075 11bit, 1C accuracy
SHT3x 0x44, 0x34 SHT3x Series Temperature and Humidity sensors (SHT30, SHT31, SHT35) Not always found when scanning bus (SYS:I2C:SCAN?)
SHT4x 0x44 SHT4x Series Temperature and Humidity sensors (SHT40, SHT41, SHT43, SHT45) Not always found when scanning bus (SYS:I2C:SCAN?)
SHTC3 0x70 Temperature and Humidity sensor, 0.2C accuracy
STTS22H 0x38, 0x3c, 0x3e, 0x3f 16bit, 0.5C accuracy
TMP102 0x48, 0x49, 0x4a, 0x4b 12bit, 2C accuracy
TMP117 0x48, 0x49, 0x4a, 0x4b 16bit, 0.1C accuracy

Defaults:

Default for all virtual sensors is to be in "MANUAL" mode and revert automatically to 0C if no temperature update has been received within 30 seconds.

VSENSOR SOURCE
1 MANUAL,0,30
... ...

Example: Set VSENSOR1 to report temperature that is updated by external program. And to sensor reading to revert to default value of 99C if no update has been received within 5 seconds.

CONF:VSENSOR2:SOURCE manual,99,5

Example: Set VSENSOR2 to follow report temperature delta between SENSOR1 and SENSOR2.

CONF:VSENSOR2:SOURCE delta,1,2

Example: Set VSENSOR3 to report average temperature between SENSOR1, SENSOR2, and VSENSOR1

CONF:VSENSOR3:SOURCE avg,1,2,101

Example: Set VSENSOR4 to report temperature from 1-Wire sensor with address 2871d86a0000005a:

CONF:VSENSOR4:SOURCE onewire,2871d86a0000005a

(to get list of currently active 1-Wire sensors use: SYS:ONEWIRE:SENSORS?)

Example: Set VSENSOR5 to report temperature from TMP117 (I2C) sensor with address 0x48:

CONF:VSENSOR5:SOURCE i2c,0x48,tmp117

(to get list of currently active I2C sensor addresses, use: SYS:I2C:SCAN?)

CONFigure:VSENSORx:SOUrce?

Query a virtual temperature sensor configuration (temperature reading source).

Command returns response in following format:

mode,parameter,parameter,...

Example:

CONF:VSENSOR1:SOU?
manual,99.0,5

CONFigure:VSENSORx:TEMPMap

Set mapping (curve) for converting temperature to PWM signal duty cycle (%). This can be used to customize how temperature affects fan speed.

Mapping is specified with up to 32 points (that can be plotted as a curve) that map the relation of the temperature (x value) to output PWM signal (y value). Mapping should at minimum include that start and end points of the expected input signal.

Default mapping:

x (Temperature in C) y (Fan Duty Cycle in %)
20 0
50 100

Example: Set Fan to start running at 20% duty cycle at 25C and to be full speed at 50C

CONF:VSENSOR1:TEMPMAP 25,20,50,100

CONFigure:VSENSORx:TEMPMap?

Display currently active mapping (curve) for convertin measured temperature to PWM duty cycle (%) for the fan output signal.

Mapping is displayed as comma separated list of values:

x_1,y_1,x_2,y_2,...,x_n,y_n

For example:

CONF:VSENSOR1:TEMPMAP?
20,0,50,10000

CONFigure:VSENSORx:FILTER

Configure filter to be applied to the temperature signal received from the sensor.

List of available filters can be found here: Available Filters

By default, no filter is applied (filter is set to "none").

Example: Set filter for the input signal to "Simple Moving Average", that can be useful with noisy readings from temperature sensors.

CONF:VSENSOR1:FILTER sma,10

CONFigure:VSENSORx:FILTER?

Display currently active filter for the temperature signal received from the sensor.

Format: filter,arg_1,arg_2,...arg_n

For example:

CONF:VENSOR1:FILTER?
sma,10

MEASure Commands

These commands are for reading (measuring) the current input/output values on Fan and Motherboard Fan ports.

MEASure:Read?

This command returns all measurements for all FAN and MBFAN, and SENSOR ports. (This is same as: Read?)

Response format:

mbfan<n>,"<name>",<output rpm>,<output tacho frequency>,<input pwm duty cycle>
...
fan<n>,"<name>",<input rpm>,<input tacho frequency>,<output pwm duty cycle>
...
sensor<n>,"<name>",<temperature>,<pwm duty cycle>
...
vsensor<n>,"<name>",<temperature>,<pwm duty cycle>

Example:

MEAS:READ?
mbfan1,"CPU Fan",1020,34.00,63.0
mbfan2,"Chassis Fan 1",468,15.60,63.0
mbfan3,"Chassis Fan 2",534,17.80,63.0
mbfan4,"Chassis Fan 3",417,13.90,63.0
fan1,"CPU Fan",1020,34.00,63.0
fan2,"Rear Exhaust",468,15.60,31.5
fan3,"unused",0,0.00,20.0
fan4,"unused",0,0.00,20.0
fan5,"Front Intake 1",534,17.80,35.0
fan6,"Front Intake 2",420,14.00,35.0
fan7,"Top Exhaust 1",417,13.90,22.8
fan8,"Top Exhaust 2",462,15.40,22.8
sensor1,"Intake Air",22.4,7.9
sensor2,"Exhaust Air",30.5,35.0
sensor3,"RPi Pico",26.5,21.8
vsensor1,"CPU Temp",55.0,60.5
vsensor2,"unused",0.0,20.0
vsensor3,"unused",0.0,20.0
vsensor4,"unused",0.0,20.0
vsensor5,"unused",0.0,20.0
vsensor6,"unused",0.0,20.0
vsensor7,"unused",0.0,20.0
vsensor8,"unused",0.0,20.0

MEASure:FANx Commands

MEASure:FANx?

Return current fan speed (RPM), tacho meter frequency (Hz), and output PWM signal duty cycle (%) for a fan.

Response format:

<duty_cycle>,<frequency>,<rpm>

Example:

MEAS:FAN1?
42,34.4,1032

MEASure:FANx:Read?

Return current fan speed (RPM), tacho meter frequency (Hz), and output PWM signal duty cycle (%) for a fan.

This is same as: MEASure:FANx?

Response format:

<duty_cycle>,<frequency>,<rpm>

Example:

MEAS:FAN1:R?
42,34.4,1032

MEASure:FANx:RPM?

Return current fan speed (RPM).

Example:

MEAS:FAN1:RPM?
1032

MEASure:FANx:PWM?

Return current fan (output) PWM signal duty cycle (%).

Example:

MEAS:FAN1:PWM?
42

MEASure:FANx:TACHo?

Return current fan tachometer (speed) signal frequency (Hz).

Example:

MEAS:FAN1:TACH?
34.4

MEASure:MBFANx Commands

MEASure:MBFANx?

Return current motherboard fan connector signals. Output fan speed speed (RPM), output tacho meter frequency (Hz), and input PWM signal duty cycle (%) for a mbfan.

Response format:

<duty_cycle>,<frequency>,<rpm>

Example:

MEAS:MBFAN1?
49,34.4,1032

MEASure:MBFANx:Read?

Return current fan speed (RPM), tacho meter frequency (Hz), and output PWM signal duty cycle (%) for a fan.

This is same as: MEASure:MBFANx?

Response format:

<duty_cycle>,<frequency>,<rpm>

Example:

MEAS:MBFAN1:R?
49,34.4,1032

MEASure:MBFANx:RPM?

Return current fan speed (RPM) reported out to motherboard.

Example:

MEAS:MBFAN1:RPM?
1032

MEASure:MBFANx:PWM?

Return current fan (input) PWM signal duty cycle (%) received from motherboard.

Example:

MEAS:MBFAN1:PWM?
49

MEASure:MBFANx:TACHo?

Return current fan tachometer (speed) signal frequency (Hz) reported out to motherboard.

Example:

MEAS:MBFAN1:TACH?
34.4

MEASure:SENSORx Commands

MEASure:SENSORx?

Return current temperature (C) measured by the sensor.

Example:

MEAS:SENSOR1?
25

MEASure:SENSORx:Read?

Return current temperature (C) measured by the sensor.

This is same as: MEASure:SENSORx?

Example:

MEAS:SENSOR1:R?
25

MEASure:SENSORx:TEMP?

Return current temperature (C) measured by the sensor.

This is same as: MEASure:SENSORx?

Example:

MEAS:SENSOR1:TEMP?
25

MEASure:VSENSORS?

Return all measurements for all virtual sensors.

Format: sensor,temperature_C,humidity_%,pressure_hPa

Example:

MEAS:VSENSORS?
vsensor1,"vsensor1",24.4,0,0
vsensor2,"vsensor2",24.9,0,0
vsensor3,"vsensor3",24.8,43,0
vsensor4,"vsensor4",26.5,0,997
vsensor5,"vsensor5",25.1,0,991
vsensor6,"vsensor6",0.0,0,0
vsensor7,"vsensor7",0.0,0,0
vsensor8,"vsensor8",0.0,0,0

MEASure:VENSORx?

Return current temperature (C) measured by the sensor.

Example:

MEAS:VSENSOR1?
25

MEASure:VSENSORx:HUMidity?

Return current humidity (%) measured by the sensor.

Example:

MEAS:VSENSOR1:HUM?
45

MEASure:VSENSORx:PREssure?

Return current pressure (hPa) measured by the sensor.

Example:

MEAS:VSENSOR1:PRE?
1013

MEASure:VSENSORx:Read?

Return current temperature (C) measured by the sensor.

This is same as: MEASure:VSENSORx?

Example:

MEAS:VSENSOR1:R?
25

MEASure:VSENSORx:TEMP?

Return current temperature (C) measured by the sensor.

This is same as: MEASure:VSENSORx?

Example:

MEAS:VSENSOR1:TEMP?
25

Read Commands

Read?

This command returns all measurements for all FAN and MBFAN, and SENSOR ports. (This is same as: MEASure:Read?)

Response format:

mbfan<n>,"<name>",<output rpm>,<output tacho frequency>,<input pwm duty cycle>
...
fan<n>,"<name>",<input rpm>,<input tacho frequency>,<output pwm duty cycle>
...
sensor<n>,"<name>",<temperature>,<pwm duty cycle>
...
vsensor<n>,"<name>",<temperature>,<pwm duty cycle>

Example:

mbfan1,"CPU Fan",1020,34.00,63.0
mbfan2,"Chassis Fan 1",468,15.60,63.0
mbfan3,"Chassis Fan 2",534,17.80,63.0
mbfan4,"Chassis Fan 3",417,13.90,63.0
fan1,"CPU Fan",1020,34.00,63.0
fan2,"Rear Exhaust",468,15.60,31.5
fan3,"unused",0,0.00,20.0
fan4,"unused",0,0.00,20.0
fan5,"Front Intake 1",534,17.80,35.0
fan6,"Front Intake 2",420,14.00,35.0
fan7,"Top Exhaust 1",417,13.90,22.8
fan8,"Top Exhaust 2",462,15.40,22.8
sensor1,"Intake Air",22.4,7.9
sensor2,"Exhaust Air",30.5,35.0
sensor3,"RPi Pico",26.5,21.8
vsensor1,"CPU Temp",55.0,60.5
vsensor2,"unused",0.0,20.0
vsensor3,"unused",0.0,20.0
vsensor4,"unused",0.0,20.0
vsensor5,"unused",0.0,20.0
vsensor6,"unused",0.0,20.0
vsensor7,"unused",0.0,20.0
vsensor8,"unused",0.0,20.0

SYStem Commands

SYStem:ERRor?

Display status from last command.

Example:

SYS:ERR?
0,"No Error"

SYStem:DEBug

Set the system debug level. This controls the logging to the console.

Default: 0 (do not log any debug messages)

Example: Enable verbose debug output

SYS:DEBUG 2

SYStem:DEBug?

Display current system debug level.

Example:

SYS:DEBUG?
0

SYStem:LOG

Set the system logging level. This controls the level of logging to the console.

Default: WARNING

Log Levels:

Level Name
0 EMERG
1 ALERT
2 CRIT
3 ERR
4 WARNING
5 NOTICE
6 INFO
7 DEBUG

Example: Enable verbose debug output

SYS:LOG DEBUG

SYStem:LOG?

Display current system logging level.

Example:

SYS:LOG?
NOTICE

SYStem:SYSLOG

Set the syslog logging level. This controls the level of logging to a remote syslog server.

Default: ERR

Log Levels:

Level Name
0 EMERG
1 ALERT
2 CRIT
3 ERR
4 WARNING
5 NOTICE
6 INFO
7 DEBUG

Example: Enable logging of NOTICE (and lower level) message:

SYS:LOG NOTICE

SYStem:SYSLOG?

Display current syslog logging level.

Example:

SYS:SYSLOG?
ERR

SYStem:DISPlay

Set display (module) parameters as a comma separated list.

This can be used to set display module type if cannot be automatically detected. Additionally this can be used to set some display parameters like brightness.

Default: default

Currently supported values:

Value Description Notes
default Use default settings (auto-detect).
none Disable OLED support Skips scanning for OLED panel.
128x64 OLED 128x64 module installed. OLED
128x128 OLED 128x128 module installed. OLED
132x64 OLED 132x64 installed (some 1.3" 128x64 modules need this setting!) OLED
flip Flip display (upside down) OLED and LCD
invert Invert display OLED and LCD
brightness=n Set display brightness (%) to n (where n=0..100) [default: 50] OLED
rotate=n Rotate display n degrees (where n=0, 90, 180, 270) [default: 90] LCD only
swapcolors Swap Red and Blue colors (use if colors dont show up correctly) LCD only
spifreq=n Set SPI Bus frequency (values < 1000 assumed to be in MHz, values >1000 assumed to be in Hz) [default: 48 (MHz)] LCD only
16bit Use 16bit SPI bus transfers only (needed often for display modules made for Raspberry Pi) LCD only

Example: 1.3" (SH1106) module installed that doesn't get detected correctly

SYS:DISP 132x64

Example: Invert display and set brightnes to 30%

SYS:DISP default,invert,brightness=30

SYStem:DISPlay?

Display current display module setting.

Example:

SYS:DISP?
132x64,flip,invert,brightness=75

SYStem:DISPlay:LAYOUTR

Configure (OLED) Display layout for the right side of the screen.

Layout is specified as a comma delimited string describing what to display on each row (8 rows available if using 128x64 OLEd module, 10 rows available with 128x128 pixel modules).

Syntax: ,,...

Where tow specifications can be one of the following:

Type Description Notes
Mn MBFan input n n=1..4
Sn Sensor input n n=1..3
Vn Virtual Sensor input n n=1..8
- Horizontal Line
Ltext Line with "text" Max length 9 characters.

Default:

When this setting is not set following defaults are used based on the OLED module size:

Screen Size Available Rows Default Configuration
128x64 8 M1,M2,M3,M4,-,S1,S2,S3
128x128 10 LMB Inputs,M1,M2,M3,M4,-,LSensors,S1,S2,S3

Example: configure custom theme (for 128x64 display):

SYS:DISP:LAYOUTR M1,M2,-,S1,S2,S3,V1,V2

SYStem:DISPlay:LAYOUTR?

Display currently configured (OLED) Display layout for the right side of the screen.

Example:

SYS:DISP:THEME?
M1,M2,-,S1,S2,S3,V1,V2

SYStem:DISPlay:LOGO

Configure (LCD) Display boot logo.

Currently available logos:

Name Description
default Default FanPico boot logo.
custom Custom boot logo (only available if firmware has been compiled with custom logo included).

Example: configure custom logo

SYS:DISP:LOGO custom

SYStem:DISPlay:LOGO?

Display currently configured (LCD) Display boot logo.

Example:

SYS:DISP:LOGO?
default

SYStem:DISPlay:THEMe

Configure (LCD) Display theme to use.

Default: default

Example: configure custom theme

SYS:DISP:THEME custom

SYStem:DISPlay:THEMe?

Display currently configured (LCD) display theme name.

Example:

SYS:DISP:THEME?
default

SYStem:ECHO

Enable or disaple local echo on the console. This can be useful if interactively programming Fanpico.

Value Status
0 Local Echo disabled.
1 Local Echo enabled.

Default: 0

Example: enable local echo

SYS:ECHO 1

Example: disable local echo

SYS:ECHO 0

SYStem:ECHO?

Display local echo status:

Example:

SYS:ECHO?
0

SYStem:FANS?

Display number of FAN output ports available.

Example:

SYS:FANS?
8

SYStem:FLASH?

Returns information about Pico flash memory usage.

Example:

SYS:FLASH?
Flash memory size:                     2097152
Binary size:                           683520
LittleFS size:                         262144
Unused flash memory:                   1151488

SYStem:I2C?

Returns status if I2C bus is active (available) currently. Depening on board model I2C may not be available at all or may only be available if SPI is not active.

Returns:

status description
0 I2C Bus not available
1 I2C Bus available

Example:

SYS:I2C?
1

SYStem:I2C:SCAN?

Scan I2C Bus for active devices. This returns addresses of any devices found on I2C bus.

Example:

SYS:I2C:SCAN??
Scanning I2C Bus... 0x3c
Device(s) found: 1

SYStem:I2C:SPEED

Set speed that I2C bus operates. Note, change won't take effect until unit is rebooted.

Speed range: 10000 - 3400000 (speeds over 1000000 may not work reliably)

Default: 1000000 (1000 kHz or 1000 kbit/s)

Example:

SYS:I2C:SPEED 1000000
CONF:SAVE

SYStem:I2C:SPEED?

Return currently configured I2C bus speed (Hz or bit/s).

Example:

SYS:I2C:SPEED?
1000000

SYStem:LED

Set system indicator LED operating mode.

Supported modes:

mode description
0 LED blinking slowly [default]
1 LED on (continuously)
2 LED off

Default: 0

Example to set LED to be on continuously:

SYS:LED 1

SYStem:LED?

Query current system LED operating mode.

Example:

SYS:LED?
0

SYStem:LFS?

Display information about the LittleFS filesystem in the flash memory.

Example:

SYS:LFS?
Filesystem size:                       262144
Filesystem used:                       24576
Filesystem free:                       237568
Number of files:                       3
Number of subdirectories:              0

SYStem:LFS:FORMAT

Format flash filesystem. This will erase current configuration (including any TLS certificates saved in flash).

Example (format filesystem and save current configuration):

SYS:LFS:FORMAT
CONF:SAVE

SYStem:MBFANS?

Display number of MBFAN input ports available.

Example:

SYS:MBFANS?
4

SYStem:MEM

Test how much available (heap) memory system currently has. This does simple test to try to determine what is the largest block of heap memory that is currently available as well as try allocating as many as possible small block of memory to determine roughly the total available heap memory.

This command takes optional 'blocksize' parameter to specify the memory block size to use in the tests. Default is 1024 bytes.

Example:

SYS:MEM 512
Largest available memory block:        114688 bytes
Total available memory:                111104 bytes (217 x 512bytes)

SYStem:MEM?

Returns information about heap and stack size. As well as information about current (heap) memory usage as returned by mallinfo() system call.

Note, mallinfo() does not always "see" all of the available heap memory, unless SYS:MEM command has been run first.

Example:

SYS:MEM?
Core0 stack size:                      8192
Core1 stack size:                      4096
Heap size:                             136604
mallinfo:
Total non-mmapped bytes (arena):       136604
# of free chunks (ordblks):            2
# of free fastbin blocks (smblks):     0
# of mapped regions (hblks):           0
Bytes in mapped regions (hblkhd):      0
Max. total allocated space (usmblks):  0
Free bytes held in fastbins (fsmblks): 0
Total allocated space (uordblks):      21044
Total free space (fordblks):           115560
Topmost releasable block (keepcost):   114808

SYStem:MQTT Commands

FanPico has MQTT Client that can be configured to publish (send) periodic status updates to a topic. Additionally MQTT Client support subscribing to a "command" topic to listen for commands. This allows remotely controlling BrickPico.

To enable MQTT at minimum server and user must be configured. To explicitly disbable MQTT set server to empty string.

SYStem:MQTT:SERVer

Set MQTT server to connect to. This parameter expects a DNS name as argument.

Default: (when this setting is empty string, MQTT is explicitly disabled)

Example (configure MQTT server name):

SYS:MQTT:SERVER io.adafruit.com

Example (disable MQTT):

SYS:MQTT:SERVER

SYStem:MQTT:SERVer?

Query currently set MQTT server name.

Example:

SYS:MQTT:SERVER?
io.adafruit.com

SYStem:MQTT:PORT

Set MQTT server (TCP) port. This setting is needed when MQTT server is not using standard port. If this setting is not set (value is left to default "0"), then standard MQTT port is used.

  • Secure (TLS) Port = 8883
  • Insecure Port = 1883

Default: 0 (when this setting is 0 use default MQTT ports)

Example:

SYS:MQTT:PORT 9883

SYStem:MQTT:PORT?

Query currently set MQTT (TCP) port.

If return value is zero (0), then default MQTT port is being used.

Example:

SYS:MQTT:PORT?
0

SYStem:MQTT:USER

Set MQTT username to use when connecting to MQTT server.

Default:

Example:

SYS:MQTT:USER myusername

SYStem:MQTT:USER?

Query currently set MQTT username.

Example:

SYS:MQTT:USER?
myusername

SYStem:MQTT:PASS

Set MQTT password to use when connecting to MQTT server.

Default:

Example:

SYS:MQTT:PASS mymqttpassword

SYStem:MQTT:PASS?

Query currently set MQTT password.

Example:

SYS:MQTT:PASS?
mymqttpassword

SYStem:MQTT:SCPI

Configure if SCPI all commands will be accepted via MQTT. If this is not enabled then only "WRITE" commands are allowed.

This is potentially "dangerous" feature, so only enable if you understand the potential risks allowing device to be remotely configured.

Default: OFF

Example:

SYS:MQTT:SCPI ON

SYStem:MQTT:SCPI?

Query whether all SCPI commands are allowed via MQTT.

Example:

SYS:MQTT:SCPI?
OFF

SYStem:MQTT:TLS

Enable/disable use of secure connection mode (TLS/SSL) when connecting to MQTT server. Default is TLS on to protect MQTT credentials (usename/password).

Default: ON

Example:

SYS:MQTT:TLS OFF

SYStem:MQTT:TLS?

Query whether TLS is enabled or disabled for MQTT.

Example:

SYS:MQTT:TLS?
ON

SYStem:MQTT:HA:DISCovery

Configure Home Assistant MQTT Discovery prefix. This must be set to enable Home Assistant support/integration in FanPico.

If this is left to empty (string), then Home Assistant support is disabled.

Default:

Example (enable Home Assistant support using default prefix):

SYS:MQTT:HA:DISC homeassistant

SYStem:MQTT:HA:DISCovery?

Query currently set Home Assistant MQTT Discovery prefix.

Note, if this is empty, then Home Assistant support is disabled.

Example:

SYS:MQTT:HA:DISC?
homeassistant

SYStem:MQTT:INTerval:STATUS

Configure how often unit will publish (send) status message to status topic. Set this to 0 (seconds) to disable publishing status updates. Recommended values are 60 (seconds) or higher.

Default: 600 (every 10 minutes)

Example:

SYS:MQTT:INT:STATUS 3600

SYStem:MQTT:INTerval:STATUS?

Query how often unit is setup to publish data to status topic.

Example:

SYS:MQTT:INT:STATUS?
3600

SYStem:MQTT:INTerval:TEMP

Configure how often unit will publish (send) status temperature sensor status messages. Set this to 0 (seconds) to disable publishing status updates. Recommended values are 60 (seconds) or higher.

Default: 0 (disabled)

Example:

SYS:MQTT:INT:TEMP 60

SYStem:MQTT:INTerval:TEMP?

Query how often unit is setup to publish temperature status messages.

Example:

SYS:MQTT:INT:TEMP?
60

SYStem:MQTT:INTerval:VSENsor

Configure how often unit will publish (send) virtual sensor status messages. Set this to 0 (seconds) to disable publishing status updates. Recommended values are 60 (seconds) or higher.

Default: 0 (disabled)

Example:

SYS:MQTT:INT:VSEN 60

SYStem:MQTT:INTerval:VSENsor?

Query how often unit is setup to publish virtual sensor status messages.

Example:

SYS:MQTT:INT:VSENP?
60

SYStem:MQTT:INTerval:RPM

Configure how often unit will publish (send) RPM status updates for fans (and mbfans).

Set this to 0 (seconds) to disable publishing status updates. Recommended values are 60 (seconds) or higher.

Default: 0 (disabled)

Example:

SYS:MQTT:INT:RPM 60

SYStem:MQTT:INTerval:RPM?

Query how often unit is setup to publish fan/mbfan RPM status messages.

Example:

SYS:MQTT:INT:RPM?
60

SYStem:MQTT:INTerval:PWM

Configure how often unit will publish (send) PWM (duty cycle) status updates for fans/mbfans.

Set this to 0 (seconds) to disable publishing status updates. Recommended values are 60 (seconds) or higher.

Default: 0 (disabled)

Example:

SYS:MQTT:INT:PWM 60

SYStem:MQTT:INTerval:PWM?

Query how often unit is setup to publish fan/mbfan PWM (duty cycle) status messages.

Example:

SYS:MQTT:INT:PWM?
60

SYStem:MQTT:MASK:TEMP

Configure which temperature sensors should publish (send) data to MQTT server.

Sensors can be specified as comma separated list (2,3) or as range (1-3) or as combination of both.

Default: (do not publish data from any sensor)

Example:

SYS:MQTT:MASK:TEMP 1,3

SYStem:MQTT:MASK:TEMP?

Query which sensors are configured to publish (send) data to MQTT server.

Example:

SYS:MQTT:MASK:TEMP?
1,3

SYStem:MQTT:MASK:VTEMP

Configure which virtual sensors should publish (send) temperature data to MQTT server.

Sensors can be specified as comma separated list (2,3) or as range (1-3) or as combination of both.

Default: (do not publish data from any sensor)

Example:

SYS:MQTT:MASK:VTEMP 1,2,3,4

SYStem:MQTT:MASK:VTEMP?

Query which virtual sensors are configured to publish (send) temperature data to MQTT server.

Example:

SYS:MQTT:MASK:VTEMP?
1-4

SYStem:MQTT:MASK:VHUMidity

Configure which virtual sensors should publish (send) humidity data to MQTT server.

Sensors can be specified as comma separated list (2,3) or as range (1-3) or as combination of both.

Default: (do not publish data from any sensor)

Example:

SYS:MQTT:MASK:VHUM 1,2

SYStem:MQTT:MASK:VHUMidity?

Query which virtual sensors are configured to publish (send) humidity data to MQTT server.

Example:

SYS:MQTT:MASK:VHUM?
1-2

SYStem:MQTT:MASK:VPREssure

Configure which virtual sensors should publish (send) pressure data to MQTT server.

Sensors can be specified as comma separated list (2,3) or as range (1-3) or as combination of both.

Default: (do not publish data from any sensor)

Example:

SYS:MQTT:MASK:VPRE 1,2

SYStem:MQTT:MASK:VPREssure?

Query which virtual sensors are configured to publish (send) pressure data to MQTT server.

Example:

SYS:MQTT:MASK:VPRE?
1-2

SYStem:MQTT:MASK:FANRPM

Configure which fan ports should publish (send) RPM data to MQTT server.

Ports can be specified as comma separated list (2,3) or as range (1-3) or as combination of both.

Default: (do not publish data from any port)

Example:

SYS:MQTT:MASK:FANRPM 1,3,5-8

SYStem:MQTT:MASK:FANRPM?

Query which fans are configured to publish (send) RPM data to MQTT server.

Example:

SYS:MQTT:MASK:FANRPM?
1-8

SYStem:MQTT:MASK:FANPWM

Configure which fan ports should publish (send) PWM data to MQTT server.

Ports can be specified as comma separated list (2,3) or as range (1-3) or as combination of both.

Default: (do not publish data from any port)

Example:

SYS:MQTT:MASK:FANPWM 1-4

SYStem:MQTT:MASK:FANPWM?

Query which fans are configured to publish (send) PWM data to MQTT server.

Example:

SYS:MQTT:MASK:FANPWM?
1-4

SYStem:MQTT:MASK:MBFANRPM

Configure which mbfan ports should publish (send) RPM data to MQTT server.

Ports can be specified as comma separated list (2,3) or as range (1-3) or as combination of both.

Default: (do not publish data from any port)

Example:

SYS:MQTT:MASK:MBFANRPM 1,4

SYStem:MQTT:MASK:MBFANRPM?

Query which mbfans are configured to publish (send) RPM data to MQTT server.

Example:

SYS:MQTT:MASK:MBFANRPM?
1,4

SYStem:MQTT:MASK:MBFANPWM

Configure which mbfan ports should publish (send) PWM data to MQTT server.

Ports can be specified as comma separated list (2,3) or as range (1-3) or as combination of both.

Default: (do not publish data from any port)

Example:

SYS:MQTT:MASK:MBFANPWM 1-2

SYStem:MQTT:MASK:MBFANPWM?

Query which mbfans are configured to publish (send) PWM data to MQTT server.

Example:

SYS:MQTT:MASK:MBFANPWM?
1-2

SYStem:MQTT:TOPIC:STATus

Configure topic to publish unit status information periodically. If this is left to empty (string), then no status information is published to MQTT server.

Default:

Example:

SYS:MQTT:TOPIC:STATUS musername/feeds/fanpico1

SYStem:MQTT:TOPIC:STATus?

Query currently set topic for publishing unit status information to.

Example:

SYS:MQTT:TOPIC:STATUS?
myusername/feeds/fanpico1

SYStem:MQTT:TOPIC:COMMand

Configure topic to subscribe to to wait for commands to control outputs. If this is left to empty (string), then unit won't subcrible (and accept) any commands from MQTT.

Default:

Example:

SYS:MQTT:TOPIC:COMM musername/feeds/cmd

SYStem:MQTT:TOPIC:COMMand?

Query currently set topic for subscribing to wait for commands.

Example:

SYS:MQTT:TOPIC:COMM?
myusername/feeds/cmd

SYStem:MQTT:TOPIC:RESPonse

Configure topic to publish responses to commands received from the command topic. If this is left to empty, then unit won't send response to any commands.

Default:

Example:

SYS:MQTT:TOPIC:RESP musername/feeds/response

SYStem:MQTT:TOPIC:RESPonse?

Query currently set topic for publishing responses to commands.

Example:

SYS:MQTT:TOPIC:RESP?
myusername/feeds/response

SYStem:MQTT:TOPIC:TEMP

Configure topic template for publishing temperature sensor data to. If this is left to empty, then unit won't send response to any commands.

This is template string where %d should be used to mark the port number.

Default:

Example:

SYS:MQTT:TOPIC:TEMP mysername/feeds/temp%d

SYStem:MQTT:TOPIC:TEMP?

Query currently set topic template for temperature sensor data.

Example:

SYS:MQTT:TOPIC:TEMP?
myusername/feeds/temp%d

SYStem:MQTT:TOPIC:VTEMP

Configure topic template for publishing virtual sensor temperature data to. If this is left to empty, then unit won't send response to any commands.

This is template string where %d should be used to mark the port number.

Default:

Example:

SYS:MQTT:TOPIC:VTEMP mysername/feeds/vtemp%d

SYStem:MQTT:TOPIC:VTEMP?

Query currently set topic template for virtual sensor temperature data.

Example:

SYS:MQTT:TOPIC:VTEMP?
myusername/feeds/vtemp%d

SYStem:MQTT:TOPIC:VHUMidity

Configure topic template for publishing virtual sensor humidity data to. If this is left to empty, then unit won't send response to any commands.

This is template string where %d should be used to mark the port number.

Default:

Example:

SYS:MQTT:TOPIC:VHUM mysername/feeds/humidity%d

SYStem:MQTT:TOPIC:VHUMidity?

Query currently set topic template for virtual sensor humidity data.

Example:

SYS:MQTT:TOPIC:VHUM?
myusername/feeds/humidity%d

SYStem:MQTT:TOPIC:VPREssure

Configure topic template for publishing virtual sensor pressure data to. If this is left to empty, then unit won't send response to any commands.

This is template string where %d should be used to mark the port number.

Default:

Example:

SYS:MQTT:TOPIC:VPRE mysername/feeds/pressure%d

SYStem:MQTT:TOPIC:VPREssure?

Query currently set topic template for virtual sensor pressure data.

Example:

SYS:MQTT:TOPIC:VPRE?
myusername/feeds/pressure%d

SYStem:MQTT:TOPIC:FANRPM

Configure topic template for publishing fan RPM data to. If this is left to empty, then unit won't send response to any commands.

This is template string where %d should be used to mark the port number.

Default:

Example:

SYS:MQTT:TOPIC:FANRPM musername/feeds/fanrpm%d

SYStem:MQTT:TOPIC:FANRPM?

Query currently set topic template for fan RPM data.

Example:

SYS:MQTT:TOPIC:FANRPM?
myusername/feeds/fanrpm%d

SYStem:MQTT:TOPIC:FANPWM

Configure topic template for publishing fan PWM data to. If this is left to empty, then unit won't send response to any commands.

This is template string where %d should be used to mark the port number.

Default:

Example:

SYS:MQTT:TOPIC:FANPWM musername/feeds/fanpwm%d

SYStem:MQTT:TOPIC:FANPWM?

Query currently set topic template for fan PWM data.

Example:

SYS:MQTT:TOPIC:FANPWM?
myusername/feeds/fanpwm%d

SYStem:MQTT:TOPIC:MBFANRPM

Configure topic template for publishing mbfan RPM data to. If this is left to empty, then unit won't send response to any commands.

This is template string where %d should be used to mark the port number.

Default:

Example:

SYS:MQTT:TOPIC:MBFANRPM musername/feeds/mbfanrpm%d

SYStem:MQTT:TOPIC:MBFANRPM?

Query currently set topic template for mbfan RPM data.

Example:

SYS:MQTT:TOPIC:MBFANRPM?
myusername/feeds/mbfanrpm%d

SYStem:MQTT:TOPIC:MBFANPWM

Configure topic template for publishing mbfan PWM data to. If this is left to empty, then unit won't send response to any commands.

This is template string where %d should be used to mark the port number.

Default:

Example:

SYS:MQTT:TOPIC:MBFANPWM musername/feeds/mbfanpwm%d

SYStem:MQTT:TOPIC:MBFANPWM?

Query currently set topic template for mbfan PWM data.

Example:

SYS:MQTT:TOPIC:MBFANPWM?
myusername/feeds/mbfanpwm%d

SYStem:NAME

Set name of the system. (Default: fanpico1)

Example:

SYS:NAME HomeServer

SYStem:NAME?

Get name of the system.

Example:

SYS:NAME?
HomeServer

SYStem:ONEWIRE

new: release v1.6.4
Enable or disable 1-Wire Bus. This is disabled by default. Enabling 1-Wire bus allows use of 1-Wire temperature sensors.

Note, unit must be rebooted for the change to take effect.

Example (enable 1-Wire bus):

SYS:ONEWIRE ON

SYStem:ONEWIRE?

new: release v1.6.4
Return status whether 1-Wire bus is currently enabled or disabled.

Status Description
ON Enabled
OFF Disabled

Example:

SYS:ONEWIRE?
OFF

SYStem:ONEWIRE:SENSORS?

new: release v1.6.4
Return list of currently active (detected at boot time) 1-Wire bus devices, and last temperature measurement results.

Output format: ,,

Example:

SYS:ONEWIRE:SENSORS?
1,28821e6a000000cf,23.4
2,2871d86a0000005a,23.0
3,22a275180000003c,23.9

SYStem:SENSORS?

Display number of (temperature) sensors available. Last temperature sensor is the internal temperature sensor on the RP2040.

Example:

SYS:SENSORS?
3

SYStem:SERIAL

Enable or disable TTL Serial Console. This is enabled by default if board has this connector. Reason to disable this could be to use the second I2C bus that is sharing pins with the UART.

Example (disable serial console):

SYS:SERIAL OFF

SYStem:SERIAL?

Return status of TTL Serial Console.

Status Description
ON Enabled
OFF Disabled

Example:

SYS:SERIAL?
ON

SYStem:SPI

Enable or disable SPI bus (on boards that have "SPI" connector). Reason to enable SPI bus would be to connect LCD panel on the SPI connector.

NOTE! On 0804D boards, when SPI bus is enabled I2C (OLED display) and Serial (TTL) connectors cannot be used as these share pins with the SPI bus.

Example (enable SPI bus):

SYS:SPI 1

SYStem:SPI?

Return status of SPI bus.

Status Description
1 Enabled
0 Disabled

Example:

SYS:SPI?
0

SYStem:TELNET:SERVer

Control whether Telnet server is enabled or not. After making change configuration needs to be saved and unit reset.

Default: OFF

Example:

SYS:TELNET:SERV ON

SYStem:TELNET:SERVer?

Display whether Telnet server status.

Example:

SYS:TELNET:SERV?
OFF

SYStem:TELNET:AUTH

Toggle Telnet server authentication mode. When enabled then Telnet server will prompt user for login/password. When off, no authentication is needed.

Default: ON

Example:

SYS:TELNET:AUTH OFF

SYStem:TELNET:AUTH?

Display whether Telnet server authentication is enabled or not.

Example:

SYS:TELNET:AUTH?
ON

SYStem:TELNET:PORT

Set TCP port where Telnet server will listen on. If this setting is not set then default port will be used.

Default: 23 (default Telnet port)

Example:

SYS:TELNET:PORT 8000

SYStem:TELNET:PORT?

Display currently configured port for Telnet server.

(if port is set to 0, then default Telnet port will be used)

Example:

SYS:TELNET:PORT?
8000

SYStem:TELNET:RAWmode

Configure Telnet server mode. By default Telnet server uses Telnet protocol, but setting this option causes Telnet protocol to be disabled. And server uses "raw TCP" mode.

Default: OFF

Example:

SYS:TELNET:RAW ON

SYStem:TELNET:RAWmode?

Display if "raw TCP" mode is enabled or not.

Example:

SYS:TELNET:RAW?
OFF

SYStem:TELNET:USER

Configure username that is allowed to login to this server using Telnet.

Default:

Example:

SYS:TELNET:USER admin

SYStem:TELNET:USER?

Display currently configured telnet user (login) name.

Example:

SYS:TELNET:USER?
admin

SYStem:TELNET:PASSword

Configure password for the telnet user. Password is hashed using SHA-512 Crypt algorithm.

Default:

Example:

SYS:TELNET:PASS mypassword

SYStem:TELNET:PASSword?

Display currently configured telnet user password hash.

Example:

SYS:TELNET:PASS?
$6$QvD5AkWSuydeH/EB$UsYA0cymsCRSse78fN4bMb5q0hM5B7YUNSFd3zJfMDbTG7DOH8iuMufVjsvqBOxR9YCJYSHno4CFeOhLtTGLx.

SYStem:TIME

Set system Real-Time Clock (RTC) time.

This command expects time in following format: YYYY-MM-DD HH:MM:SS

Example:

SYS:TIME 2022-09-19 18:55:42

SYStem:TIME?

Return current Real-Time Clock (RTC) time. This is only available if using Pico W and it has successfully gotten time from a NTP server or RTC has been initialized using SYStem:TIME command.

Command returns nothing if RTC has not been initialized.

Example:

SYS:TIME?
2022-09-19 18:55:42

SYStem:TIMEZONE

Set POSIX timezone to use when getting time from a NTP server. If DHCP server does not supply POSIX Timezone (DHCP Option 100), then this command can be used to specify local timezone.

This command takes POSIX timezone string as argument (or if argument is blank, then it clears existinh timezone setting).

Example (set Pacific Standard time as local timezone):

SYS:TIMEZONE PST8PDT7,M3.2.0/2,M11.1.0/02:00:00

Example (clear timezone setting):

SYS:TIMEZONE

SYStem:TIMEZONE?

Return current POSIX timezone setting.

Command returns nothing if no timezone has been set.

Example:

SYS:TIMEZONE?
PST8PDT7,M3.2.0/2,M11.1.0/02:00:00

SYStem:TLS:CERT

Upload or delete TLS certificate for the HTTP server. Note, both certificate and private key must be installed before HTTPS server will activate (when system is restarted next time).

When run without arguments this will prompt to paste TLS (X.509) certificate in PEM format. When run with "DELETE" argument currently installed certificate will be deleted.

Example (upload/paste certificate):

SYS:TLS:CERT
Paste certificate in PEM format:

Example (delete existing certificate from flash memory):

SYS:TLS:CERT DELETE

SYStem:TLS:CERT?

Display currently installed certificate.

Example:

SYS:TLS:CERT?

SYStem:TLS:PKEY

Upload or delete (TLS Certificate) Private key for the HTTP server. Note, both certificate and private key must be installed before HTTPS server will activate (when system is restarted next time).

When run without arguments this will prompt to paste private key in PEM format. When run with "DELETE" argument currently installed private key will be deleted.

Example (upload/paste private key):

SYS:TLS:PKEY
Paste private key in PEM format:

Example (upload/paste EC private key and EC parameters):

SYS:TLS:PKEY 2
Paste private key in PEM format:

Example (delete existing private key from flash memory):

SYS:TLS:PKEY DELETE

SYStem:TLS:PKEY?

Display currently installed private key.

Example:

SYS:TLS:CERT?

SYStem:UPTIme?

Return time elapsed since unit was last rebooted.

Example:

SYS:UPTIME?
up 4 days, 22 hours, 27 minutes

SYStem:UPGRADE

Reboot unit to USB (BOOTSEL) mode for firmware upgrade. This command triggers fanpico to reboot and enter USB "mode", where new firmware can simply be copied to the USB drive that appears. After file has been copied, fanpico will automatically reboot to new firmware image.

Example:

SYS:VER?

SYStem:VERsion?

Display software version and copyright information.

Example:

SYS:VER?

SYStem:VSENSORS?

Display number of virtual (temperature) sensors available.

Example:

SYS:VSENSORS?
8

SYStem:VREFadc

new: release v1.6.4
Set actual (measured with a volt meter) reference voltage (Vref) for ADC.

Example:

SYS:VREFADC
3.002

SYStem:VREFadc?

new: release v1.6.4
Display currently configured ADC voltage reference voltage.

Example:

SYS:VREFADC?
3.0000

SYStem:WIFI?

Check if the unit support WiFi networking. This should be used to determine if any other "WIFI" commands will be available.

Return values:

0 = No WiFi support (Pico). 1 = WiFi supported (Pico W).

Example:

SYS:WIFI?
1

SYStem:WIFI:COUntry

Set Wi-Fi Country code. By default, the country setting for the wireless adapter is unset. This means driver will use default world-wide safe setting, which can mean that some channels are unavailable.

Country codes are two letter (ISO 3166) codes. For example, Finland = FI, Great Britain = GB, United States of Americ = US, ...

Example:

SYS:WIFI:COUNTRY US

SYStem:WIFI:COUntry?

Return currently configured country code for the Wi-Fi interface.

Codes used are the ISO 3166 standard two letter codes ('XX' means unset/worldwide setting).

Example:

SYS:WIFI:COUNTRY?
US

SYStem:WIFI:HOSTname

Set system hostname. This will be used with DHCP and SYSLOG. If hostname is not defined then system will default to generating hostname as follows: FanPico-xxxxxxxxxxxxxxxx

(where "xxxxxxxxxxxxxxxx" is the FanPico serial number)

Example:

SYS:WIFI:HOSTNAME fanpico1

SYStem:WIFI:HOSTname?

Return currently configured system hostname.

Example:

SYS:WIFI:HOSTNAME?
fanpico1

SYStem:WIFI:IPaddress

Set staticlly configured IP address.

Set address to "0.0.0.0" to enable DHCP.

Example:

SYS:WIFI:IP 192.168.1.42

SYStem:WIFI:IPaddress?

Display currently configured (static) IP address. If no static address is configured, DHCP will be used.

Set address to "0.0.0.0" to enable DHCP.

Example:

SYS:WIFI:IP?
0.0.0.0

SYStem:WIFI:MODE

Set WiFi connection mode. Normally this setting is not needed with modern APs.

However, if FanPico is failing to connect to WiFi network, this couldbe due to old firmware on the AP (upgrading to latest firmware typically helps). If firmware update did not help or there is no updated firmware available, setting connection mode to synchronous can help (however this could cause FanPico to "hang" for up to 60 seconds during boot up).

Mode Description
0 Asynchronous connection mode (default)
1 Synchronous connection mode (

Default: 0

Example:

SYS:WIFI:MODE 1

SYStem:WIFI:MODE?

Display currently configured WiFi connection mode?

Example:

SYS:WIFI:MODE?
0

SYStem:WIFI:NETMASK

Set statically configured netmask.

Example:

SYS:WIFI:NETMASK 255.255.255.0

SYStem:WIFI:NETMASK?

Display currently configured (static) netmask.

Example:

SYS:WIFI:NETMASK?
255.255.255.0

SYStem:WIFI:GATEWAY

Set statically configured default gateway (router).

Example:

SYS:WIFI:GATEWAY 192.168.1.1

SYStem:WIFI:GATEWAY?

Display currently configured default gateway (router).

Example:

SYS:WIFI:GATEWAY?
192.168.1.1

SYStem:WIFI:NTP

Configure IP for NTP server to use.

Set to "0.0.0.0" to use server provided by DHCP.

Example:

SYS:WIFI:NTP 192.168.1.10

SYStem:WIFI:NTP?

Display currently configure NTP server.

Note, "0.0.0.0" means to use DHCP.

Example:

SYS:WIFI:NTP?
192.168.1.10

SYStem:WIFI:SYSLOG

Configure IP for Syslog server to use.

Set to "0.0.0.0" to use server provided by DHCP.

Example:

SYS:WIFI:SYSLOG 192.168.1.20

SYStem:WIFI:SYSLOG?

Display currently configured Syslog server.

Note, "0.0.0.0" means to use DHCP.

Example:

SYS:WIFI:SYSLOG?
192.168.1.20

SYStem:WIFI:MAC?

Display WiFi adapter MAC (Ethernet) address.

Example:

SYS:WIFI:MAC?
28:cd:c1:01:02:03

SYStem:WIFI:SSID

Set Wi-Fi network SSID. FanPico will automatically try joining to this network.

Example

SYS:WIFI:SSID mynetwork

SYStem:WIFI:SSID?

Display currently configured Wi-Fi network SSID.

Example:

SYS:WIFI:SSID?
mynetwork

SYStem:WIFI:STATus?

Display WiFi Link status.

Return value: linkstatus,current_ip,current_netmask,current_gateway

Link Status:

Value Description
0 Link is down.
1 Connected to WiFi.
2 Connected to WiFi, but no IP address.
3 Connected to WiFi with and IP address.
-1 Connection failed.
-2 No matching SSID found(could be out of range, or down).
-3 Authentication failed (wrong password?)

Example:

SYS:WIFI:STAT?
1,192.168.1.42,255.255.255.0,192.168.1.1

SYStem:WIFI:STATS?

Display TCP/IP stack (LwIP) statistics.

NOTE, this command only works on "Debug" builds of the firmware currently.

Example

SYS:WIFI:STATS?

SYStem:WIFI:PASSword

Set Wi-Fi (PSK) password/passrase.

Example

SYS:WIFI:PASS mynetworkpassword

SYStem:WIFI:PASSword?

Display currently configured Wi-Fi (PSK) password/passphrase.

Example:

SYS:WIFI:PASS?
mynetworkpassword

WRIte Commands

These commands are for sending (writing) information from host to FanPico unit.

WRIte:VSENSORx

Set/update temperature of a virtual sensor. This can be used by a program on the host system to feed external temperature information into FanPico.

Example: Set VSENSOR1 temperature to 42.1C

WRITE:VSENSOR1 42.1