Skip to main content

A framework for testing hardware

Project description


pip install hatch

Running Tests

hatch run cov

Running Examples

hatch run examples/

Using InfluxDB

hwtest includes an InfluxDB telemetry logger. If you choose to use this, make sure you have InfluxDB configured by following the setup guide. Be sure to install version 2+, as that's the API the logger uses.

You'll also need to create an org and access token inside the InfluxDB UI (accessible via http://localhost:8086/ if running locally). The logger creates the InfluxDB client using environment variables for configuration. Specifically, you'll need to set at least INFLUXDB_V2_ORG and INFLUXDB_V2_TOKEN.

To test your configuration, run:

hatch run examples/

This should write 10 datapoints to the bucket named network-example.

You can also try the subprocess driver example, which runs the same test as the example, but attempts to log telemetry at 50 Hz in the background while running the test.

Distributing hwtest

You may need to distribute a copy of hwtest to customers so they can run tests against your hardware. In order to create packages you can distribute, run

hatch build

This will create a hwtest-*.whl file under a dist/ directory. This will include just the source code, not any examples, tests, or documentation. This .whl file can be installed on another machine with pip install filename.whl. You don't need hatch to use the .whl file.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release. See tutorial on generating distribution archives.

Built Distribution

hwtest-0.0.1-py3-none-any.whl (7.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page