cmd

package module

v0.0.0-...-5368830 Latest Latest Go to latest Published: Nov 11, 2024 License: Apache-2.0 Imports: 0 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/periph/cmd

Links

Open Source Insights

README ¶

periph - Peripherals I/O in Go

Documentation is at https://periph.io

Join us for a chat on gophers.slack.com/messages/periph, get an invite here.

cmd - ready-to-use executables

This directory contains directly usable tools installable via:

go get periph.io/x/cmd/...

Push

If you prefer to build on your workstation and push the binaries to the micro computer, install push from periph.io/x/bootstrap to cross compile and efficiently push via rsync:

go get -u periph.io/x/bootstrap/cmd/push
push -host pi@raspberrypi periph.io/x/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.
cap1xxx: Reads the capacitive sensor family.
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.
videosink: Demonstrates how to provide display contents to HTTP clients.

Troubleshooting

Having trouble getting the tools to run? File an issue or better visit the Slack channel. You can get an invite here.

Authors

periph was initiated with ❤️️ and passion by Marc-Antoine Ruel. The full list of contributors is in AUTHORS and CONTRIBUTORS.

Documentation ¶

Overview ¶

Package cmd contains tools.

Visit https://github.com/google/periph/blob/master/cmd/README.md for more information about how to use the tools provided.

Source Files ¶

View all Source files

doc.go

Directories ¶

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

Path	Synopsis
ads1x15 ads1x15 reads from ADS1015/ADS1115 Analog-Digital Converters (ADC) via I²C interface.	ads1x15 reads from ADS1015/ADS1115 Analog-Digital Converters (ADC) via I²C interface.
apa102 apa102 writes to a strip of APA102 LED.	apa102 writes to a strip of APA102 LED.
as7262 as7262 communicates with an as7262 continually reading the spectrum.	as7262 communicates with an as7262 continually reading the spectrum.
bmxx80 bmxx80 reads environmental data from a BMP180/BME280/BMP280.	bmxx80 reads environmental data from a BMP180/BME280/BMP280.
cap1xxx cap1xxx sense touches.	cap1xxx sense touches.
ccs811 ccs811 reads from a CCS811 Volatile Organic Compounds sensor via I²C interface.	ccs811 reads from a CCS811 Volatile Organic Compounds sensor via I²C interface.
ds18b20
ftdi-list ftdi prints out information about the FTDI devices found on the USB bus.	ftdi prints out information about the FTDI devices found on the USB bus.
ftdi-program ftdi-eeprom interacts with the EEPROM of a FTDI device.	ftdi-eeprom interacts with the EEPROM of a FTDI device.
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.
hd44780 hd44780 writes to a text LCD screen.	hd44780 writes to a text LCD screen.
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.
hx711 hx711 reads from a 24-bits HX711 analog to digital converter.	hx711 reads from a 24-bits HX711 analog to digital converter.
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.
ina219 ina219 communicates with an ina219 sensor reading voltage, current and power.	ina219 communicates with an ina219 sensor reading voltage, current and power.
inky inky tests an inky board.	inky tests an inky board.
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.
mcp9808 mcp9808 communicates with an mcp9808 sensor reading ambient temperature.	mcp9808 communicates with an mcp9808 sensor reading ambient temperature.
mfrc522 mfrc522 reads RFID tags.	mfrc522 reads RFID tags.
mpu9250 mpu9250 calibrates and performs the self-test, then measures the acceleration continuously.	mpu9250 calibrates and performs the self-test, then measures the acceleration continuously.
nrzled nrzled writes to a strip of LEDs using the NRZ protocol.	nrzled writes to a strip of LEDs using the NRZ protocol.
onewire-list onewire-list lists all onewire buses and devices.	onewire-list lists all onewire buses and devices.
pca9548 pca9548 scans the 8 ports of a pca9548 i2c multiplexer for other i2c devices.	pca9548 scans the 8 ports of a pca9548 i2c multiplexer for other i2c devices.
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.
gpiosmoketest Package gpiosmoketest is leveraged by periph-smoketest to verify that basic GPIO pin functionality work.	Package gpiosmoketest is leveraged by periph-smoketest to verify that basic GPIO pin functionality work.
i2csmoketest Package i2csmoketest is leveraged by periph-smoketest to verify that an I²C EEPROM device and a DS2483 device can be accessed on an I²C bus.	Package i2csmoketest is leveraged by periph-smoketest to verify that an I²C EEPROM device and a DS2483 device can be accessed on an I²C bus.
onewiresmoketest Package onewiresmoketest is leveraged by periph-smoketest to verify that a 1-wire bus search returns two devices, that a ds18b20 temperature sensor can be read, and that a ds2431 eeprom can be written and read.	Package onewiresmoketest is leveraged by periph-smoketest to verify that a 1-wire bus search returns two devices, that a ds18b20 temperature sensor can be read, and that a ds2431 eeprom can be written and read.
spismoketest Package spismoketest is leveraged by periph-smoketest to verify that an EEPROM device can be accessed on a SPI port.	Package spismoketest is leveraged by periph-smoketest to verify that an EEPROM device can be accessed on a SPI port.
periph-web periph-web runs a web server exposing periph's state.	periph-web runs a web server exposing periph's state.
sn3218 sn3218 runs a smoketest on a SN3218 LED driver with 18 LEDs over an i2c bus.	sn3218 runs a smoketest on a SN3218 LED driver with 18 LEDs over an i2c bus.
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.
internal
st7567 st7567 displays an image on a ST7567 dot matrix LCD.	st7567 displays an image on a ST7567 dot matrix LCD.
thermal thermal reads the state of thermal sensors exposed via sysfs.	thermal reads the state of thermal sensors exposed via sysfs.
tlv493d tlv493d measures the magnetic flux sensed by a tlv493d component.	tlv493d measures the magnetic flux sensed by a tlv493d component.
tm1637 tm1637 writes to a digits LED display.	tm1637 writes to a digits LED display.
videosink videosink is a simplistic example of how to use the "videosink" virtual display as an HTTP handler.	videosink is a simplistic example of how to use the "videosink" virtual display as an HTTP handler.