`sensor-max31855`¶

CLI reference¶

glasgow run sensor-max31855¶

Measure temperature with Analog Devices (Maxim) MAX31855 thermocouple-to-digital converter.

This device supports K-, J-, N-, T-, S-, R-, or E-type thermocouples. It does not have any runtime configuration: the thermocouple type is fixed for each part number.

usage: glasgow run sensor-max31855 [-h] [-V SPEC] [--cs PIN] [--sck PIN]
                                   [--so PIN]
                                   OPERATION ...

-h, --help¶: show this help message and exit

-V <spec>, --voltage <spec>¶: configure I/O port voltage to SPEC (e.g.: ‘3.3’, ‘A=5.0,B=3.3’, ‘A=SA’)

--cs <pin>¶: bind the applet I/O line ‘cs’ to PIN (default: ‘A0’, required)

--sck <pin>¶: bind the applet I/O line ‘sck’ to PIN (default: ‘A1’, required)

--so <pin>¶: bind the applet I/O line ‘so’ to PIN (default: ‘A2’, required)

glasgow run sensor-max31855 log¶

usage: glasgow run sensor-max31855 log [-h] DATA-LOGGER ...

-h, --help¶: show this help message and exit

glasgow run sensor-max31855 log csv¶

Log data to a comma-separated value (CSV) file.

usage: glasgow run sensor-max31855 log csv [-h] [--dialect DIALECT] CSV-FILE

csv-file¶: write data to CSV-FILE

-h, --help¶: show this help message and exit

--dialect {excel,excel-tab,unix}¶: format CSV file according to DIALECT

glasgow run sensor-max31855 log influxdb¶

Log data to an InfluxDB 1.x endpoint over HTTP(S).

usage: glasgow run sensor-max31855 log influxdb [-h] [-r POLICY]
                                                [-t TAG=VALUE] -p PRECISION
                                                [--batch-size BATCH-SIZE]
                                                ENDPOINT DATABASE SERIES

endpoint¶: write to endpoint URL //ENDPOINT/write

database¶: write to database DATABASE

series¶: write to measurement SERIES

-h, --help¶: show this help message and exit

-r <policy>, --retention-policy <policy>¶: write to retention policy POLICY

-t <tag=value>, --tag <tag=value>¶: attach TAG=VALUE to all data points

-p {ns,us,ms,s,m,h}, --precision {ns,us,ms,s,m,h}¶: set timestamp precision to PRECISION

--batch-size <batch-size>¶: submit data in groups of BATCH-SIZE points

glasgow run sensor-max31855 log influxdb2¶

Log data to an InfluxDB 2.x endpoint over HTTP(S).

usage: glasgow run sensor-max31855 log influxdb2 [-h] [-t TAG=VALUE]
                                                 -p PRECISION
                                                 [--batch-size BATCH-SIZE]
                                                 --token TOKEN
                                                 ENDPOINT ORGANIZATION BUCKET
                                                 SERIES

endpoint¶: write to endpoint URL //ENDPOINT/api/v2/write

organization¶: write to Organization ORGANIZATION (can be either the name or the id)

bucket¶: write to bucket BUCKET

series¶: write to measurement SERIES

-h, --help¶: show this help message and exit

-t <tag=value>, --tag <tag=value>¶: attach TAG=VALUE to all data points

-p {ns,us,ms,s,m,h}, --precision {ns,us,ms,s,m,h}¶: set timestamp precision to PRECISION

--batch-size <batch-size>¶: submit data in groups of BATCH-SIZE points

--token <token>¶: set the Token to use for Authentication

glasgow run sensor-max31855 log stdout¶

Log data to standard output in a human-readable format.

usage: glasgow run sensor-max31855 log stdout [-h]

-h, --help¶: show this help message and exit

glasgow run sensor-max31855 measure¶

usage: glasgow run sensor-max31855 measure [-h]

-h, --help¶: show this help message and exit

API reference¶

enum glasgow.applet.sensor.max31855.MAX31855Fault(value)¶

Enumeration of all detectable faults.

Valid values are as follows:

Absent = <MAX31855Fault.Absent: 'absent'>¶

Open = <MAX31855Fault.Open: 'open'>¶

ShortGND = <MAX31855Fault.ShortGND: 'short-gnd'>¶

ShortVCC = <MAX31855Fault.ShortVCC: 'short-vcc'>¶

class glasgow.applet.sensor.max31855.MAX31855Sample(*, value: float, fault: MAX31855Fault)¶

An individual temperature sample.

value: float¶: Temperature in degrees Celsius.

fault: MAX31855Fault¶: Type of the detected input fault.

class glasgow.applet.sensor.max31855.SensorMAX31855Interface(logger: Logger, assembly: AbstractAssembly, *, spi_iface: SPIControllerInterface, spi_chip: int = 0)¶

async sample() → MAX31855Sample¶: Read one temperature sample.