Download the PHP package dept-of-scrapyard-robotics/ahtx0 without Composer

Introduction

PHP Package for the AHTx0 family of temperature and relative humidity sensors.

Contains implementations for:

• AHT10
• AHT20
• AHT30

Compatible I2C Interfaces

The AHTx0 family communicates with your device over I2C, the InterIntegrated Circuit Protocol.

You can interface with an AHTx0 with this package the following ways:

• A Linux Single-Board Computer's exposed GPIO pins using the dedicated I2C SDA/SCL pins
• An MPSSE-enabled USB-to-Serial device such as an FT232H generally using D0 and SCL and D1 for SDA connected to nearly any Linux or MacOS USB port.

Dependencies

This package makes use of modules within:

• The ScrapyardIO Framework

This package also requires one of the following extensions in order to interface with I2C

• POSI Extension v^0.4.0 or newer
• FTDI Extension v^0.4.0 or newer

In addition, an extension wrapper package is needed

For ext-posi

• Microscrap POSIX Package v0.4.0 or newer
• Microscrap Native I2C Package v0.4.0 or newer

For ext-ftdi

• Microscrap FTDI Package v0.4.0 or newer
• Microscrap MPSSE Package v0.4.0 or newer

Installing from Composer

Inside the root of your PHP Project, simply require the AHTx0 package from composer

Framework Configuration

If you would like to use the ScrapyardIO Framework to bootstrap your sensor without wasting lines configuring your sensor right in the script you can add your desired configuration to scrapyard-io.php, such as in this example:

The keys you choose to represent the integrated circuit's definition are up to you.

To bootstrap quickly using a ScrapyardIO RelativeHumiditySensor object you can start with the following:

Basic Usage

To use the sensor directly without the framework simply do the following:

USB (MPSSE) driver using I2C. (Linux and MacOS)

Advanced Usage

You can select the sensor model class based on the board you wired while keeping the same I2C bootstrap pattern:

• AHT10
• AHT20
• AHT30

All three implementations expose the same core readings:

Injected into the Framework

To inject into the framework, that is, bootstrap the device directly then pass it off to a framework sensor object simply do the following:

Calibration

To calibrate the sensor output in your application layer, you can use a trusted reference sensor:

• Bootstrap or inject the sensor into RelativeHumiditySensor or TemperatureSensor.
• Make sure your sensor and the reference sensor are sampling the same air volume.
• Pull measurements at the same time from both sensors.
• Use the framework calibration call to compute compensation.

Refer to this simulated example

Sensor API

The getters and property access in this API interface with the device directly (measurement trigger + read), so you can use simple property access while still working against the chip itself.

Readable Properties (Getters)

• $sensor->relative_humidity Reads and returns relative humidity in percent.

• $sensor->temperature Reads and returns temperature in Celsius.

• $sensor->status Reads and returns the current status register value.

Writable Properties (Setters)

There are no writable magic properties exposed for AHTx0 sensors in this package.