cmd/

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/justonia/periph

Links

Open Source Insights

README ¶

periph/cmd - read-to-use executables

This directory contains directly usable tools installable via go get periph.io/x/periph/cmd/....

Recommended first use

Try first periph-info. It will print out if any driver failed to run, for example if you have to run as root to access certain drivers.

Then run headers-list to list all the headers on your board and confirm that you get the expected output. If your board is missing, you can contribute it.

Devices

apa102: Writes to a LED strip of APA-102 (sometimes called Dotstar). Can show an image animating on the Y axis.
bmxx80: Reads the temperature, pressure and humidity off a bmp180/bme280/bmp280. Humidity sensing is only supported on bme280.
ir: Reads codes (button presses) on an InfraRed remote sensor.
led: Reads the state of on-board LEDs.
ssd1306: Writes text, an image or an animated GIF to an OLED display.
tm1637: Writes to a segment digits display.

Buses

gpio-list: Looking for the GPIO pins per functionality? Prints the state of each GPIO pin.
gpio-read: Read the input value of a GPIO pin and change input resistor.
gpio-write: Change the output value of a GPIO pin.
headers-list: Pinrts the location of the pin on the header to connect your GPIO. This is the perfect tool to know where to connect the wires.
i2c-io: Reads and/or writes to an I²C device.
i2c-list: Lists which I²C buses are enabled and where the pins are.
spi-io: Reads and/or writes to an SPI device.
spi-list: Lists which SPI ports are enabled and where the pins are.

Other

periph-info: Lists which periph drivers loaded and which failed.
periph-smoketest: Runs one of the smoke test for the drivers. The smoke test differs from unit tests as they require real hardware to confirm that the driver being tested works.

Troubleshooting

Having getting the tools to run? See users/ for more documentation.

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
apa102 apa102 writes to a strip of APA102 LED.	apa102 writes to a strip of APA102 LED.
bmxx80 bmxx80 reads environmental data from a BMP180/BME280/BMP280.	bmxx80 reads environmental data from a BMP180/BME280/BMP280.
gpio-list gpio-list prints out the function of each GPIO pin.	gpio-list prints out the function of each GPIO pin.
gpio-read gpio-read reads a GPIO pin.	gpio-read reads a GPIO pin.
gpio-write gpio-write sets a GPIO pin to low or high.	gpio-write sets a GPIO pin to low or high.
headers-list headers-list prints out the headers as found on the computer and print the functionality of each pin.	headers-list prints out the headers as found on the computer and print the functionality of each pin.
i2c-io i2c-io communicates to an I²C device.	i2c-io communicates to an I²C device.
i2c-list i2c-list lists all I²C buses.	i2c-list lists all I²C buses.
ir ir reads from an IR receiver via LIRC.	ir reads from an IR receiver via LIRC.
led led reads the state of a LED or change it.	led reads the state of a LED or change it.
lepton lepton captures a single image, prints metadata about the camera state or triggers a calibration.	lepton captures a single image, prints metadata about the camera state or triggers a calibration.
periph-info periph-info prints out information about the loaded periph drivers.	periph-info prints out information about the loaded periph drivers.
periph-smoketest periph-smoketest runs all known smoke tests.	periph-smoketest runs all known smoke tests.
spi-io spi-io writes to an SPI port data from stdin and outputs to stdout or writes arguments and outputs hex encoded output.	spi-io writes to an SPI port data from stdin and outputs to stdout or writes arguments and outputs hex encoded output.
spi-list spi-list lists all SPI ports.	spi-list lists all SPI ports.
ssd1306 ssd1306 writes to a display driven by a ssd1306 controler.	ssd1306 writes to a display driven by a ssd1306 controler.
thermal thermal reads the state of thermal sensors exposed via sysfs.	thermal reads the state of thermal sensors exposed via sysfs.
tm1637 tm1637 writes to a digits LED display.	tm1637 writes to a digits LED display.