1.0.3 • Published 5 months ago

scd30-cli v1.0.3

Weekly downloads
58
License
MIT
Repository
github
Last release
5 months ago

scd30-cli

CLI for interacting with Sensirion SCD30, the CO2, temperature, and humidity sensor.

The CLI exposes all of the commands supported by the SCD30, as documented in the official Interface Description.

Uses scd30-node for communication with the SCD30.

Usage

yarn global add scd30-cli
$ scd30-cli start-continuous-measurement
Continuous measurement started.
Ambient pressure compensation deactivated.

$ scd30-cli read-measurement
╔═══════════════════╤══════════╗
║ CO2 concentration │ 1054 ppm ║
╟───────────────────┼──────────╢
║ Temperature       │ 24.15°C  ║
╟───────────────────┼──────────╢
║ Humidity          │ 31.86%   ║
╚═══════════════════╧══════════╝

Options

  • -b, --bus <number>
    • The number of the I2C bus to open. 0 for /dev/i2c-0, 1 for /dev/i2c-1, ... (default: 1)
  • -h, --help
    • output usage information

Commands

Refer to official documentation for more details on commands.

read-measurement

Read a measurement of CO2 concentration, temperature, and humidity.

status

Queries for data ready status, ASC status, FRC value, temperature offset, altitude compensation,continuous measurement interval, and firmware version

is-data-ready

Determines if a measurement can be read from the sensor's buffer.

start-continuous-measurement [pressure]

Starts continuous measurement of CO2 concentration, temperature, and humidity.

  • pressure (optional)
    • Ambient pressure to compensate CO2 measurements, 700–1400 mBar. Overrides altitude compensation. Setting to 0 deactivates ambient pressure compensation. To set new value, re-run start-continuous-measurement.

stop-continuous-measurement

Stops continuous measurement of CO2 concentration, temperature, and humidity.

set-measurement-interval <interval>

Sets the interval of continuous measurement.

  • interval
    • Interval of 2–1800 seconds

get-measurement-interval

Returns the interval of continuous measurement.

start-asc

Starts the automatic self-calibration.

stop-asc

Stops the automatic self-calibration.

get-asc-status

Returns the status of automatic self-calibration.

set-frc-value <co2ppm>

Sets the reference CO2 concentration for forced re-calibration.

  • co2ppm
    • Concentration of CO2, 400-2000 ppm

get-frc-value

Returns the reference CO2 concentration for forced re-calibration.

set-temp-offset <offset>

Sets the temperature offset.

  • offset
    • Temperature offset in units of 0.01°C

get-temp-offset

Returns the temperature offset.

set-altitude-compensation <altitude>

Sets the altitude compensation value.

  • altitude
    • Altitude in meters above sea level

get-altitude-compensation

Returns the altitude compensation value.

get-firmware-version

Returns the firmware version.

soft-reset

Performs a soft reset.

1.0.3

5 months ago

1.0.2

3 years ago

1.0.1

4 years ago

1.0.0

4 years ago