src/

Package mux implements a request router and dispatcher.

Package resize implements various image resizing methods.

Package logrus is a structured logger for Go, completely API compatible with the standard library logger.

The Test package is used for testing logrus.

Package pflag is a drop-in replacement for Go's flag package, implementing POSIX/GNU-style --flags.

Package acme provides an implementation of the Automatic Certificate Management Environment (ACME) spec.

Package autocert provides automatic access to certificates from Let's Encrypt and any other ACME-based CA.

Package argon2 implements the key derivation function Argon2.

Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing algorithm.

Package blake2b implements the BLAKE2b hash algorithm defined by RFC 7693 and the extendable output function (XOF) BLAKE2Xb.

Package blake2s implements the BLAKE2s hash algorithm defined by RFC 7693 and the extendable output function (XOF) BLAKE2Xs.

Package blowfish implements Bruce Schneier's Blowfish encryption algorithm.

Package bn256 implements a particular bilinear group.

Package cast5 implements CAST5, as defined in RFC 2144.

Package chacha20poly1305 implements the ChaCha20-Poly1305 AEAD as specified in RFC 7539, and its extended nonce variant XChaCha20-Poly1305.

Package cryptobyte contains types that help with parsing and constructing length-prefixed, binary messages, including ASN.1 DER.

Package asn1 contains supporting types for parsing and building ASN.1 messages with the cryptobyte package.

Package curve25519 provides an implementation of scalar multiplication on the elliptic curve known as curve25519.

Package ed25519 implements the Ed25519 signature algorithm.

Package hkdf implements the HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as defined in RFC 5869.

Package md4 implements the MD4 hash algorithm as defined in RFC 1320.

Package auth authenticates a message using a secret key.

Package box authenticates and encrypts small messages using public-key cryptography.

Package secretbox encrypts and authenticates small messages.

Package sign signs small messages using public-key cryptography.

Package ocsp parses OCSP responses as specified in RFC 2560.

Package openpgp implements high level operations on OpenPGP messages.

Package armor implements OpenPGP ASCII Armor, see RFC 4880.

Package clearsign generates and processes OpenPGP, clear-signed data.

Package elgamal implements ElGamal encryption, suitable for OpenPGP, as specified in "A Public-Key Cryptosystem and a Signature Scheme Based on Discrete Logarithms," IEEE Transactions on Information Theory, v.

Package errors contains common error types for the OpenPGP packages.

Package packet implements parsing and serialization of OpenPGP packets, as specified in RFC 4880.

Package s2k implements the various OpenPGP string-to-key transforms as specified in RFC 4800 section 3.7.1.

Package otr implements the Off The Record protocol as specified in http://www.cypherpunks.ca/otr/Protocol-v2-3.1.0.html

Package pbkdf2 implements the key derivation function PBKDF2 as defined in RFC 2898 / PKCS #5 v2.0.

Package pkcs12 implements some of PKCS#12.

Package poly1305 implements Poly1305 one-time message authentication code as specified in https://cr.yp.to/mac/poly1305-20050329.pdf.

Package ripemd160 implements the RIPEMD-160 hash algorithm.

Package salsa20 implements the Salsa20 stream cipher as specified in https://cr.yp.to/snuffle/spec.pdf.

Package salsa provides low-level access to functions in the Salsa family.

Package scrypt implements the scrypt key derivation function as defined in Colin Percival's paper "Stronger Key Derivation via Sequential Memory-Hard Functions" (https://www.tarsnap.com/scrypt/scrypt.pdf).

Package sha3 implements the SHA-3 fixed-output-length hash functions and the SHAKE variable-output-length hash functions defined by FIPS-202.

Package ssh implements an SSH client and server.

Package agent implements the ssh-agent protocol, and provides both a client and a server.

Package knownhosts implements a parser for the OpenSSH known_hosts host key database, and provides utility functions for writing OpenSSH compliant known_hosts files.

Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.

Package test contains integration tests for the golang.org/x/crypto/ssh package.

Package tea implements the TEA algorithm, as defined in Needham and Wheeler's 1994 technical report, “TEA, a Tiny Encryption Algorithm”.

Package twofish implements Bruce Schneier's Twofish encryption algorithm.

Package xtea implements XTEA encryption, as defined in Needham and Wheeler's 1997 technical report, "Tea extensions."

Package xts implements the XTS cipher mode as specified in IEEE P1619/D16.

Package cpu implements processor feature detection for various CPU architectures.

Package unix contains an interface to the low-level operating system primitives.

Package svc provides everything required to build Windows service.

Package debug provides facilities to execute svc.Handler on console.

Package eventlog implements access to Windows event log.

Example service program that beeps.

Package mgr can be used to manage Windows service programs.

Package periph is a peripheral I/O library.

Package cmd contains tools.

apa102 writes to a strip of APA102 LED.

bmxx80 reads environmental data from a BMP180/BME280/BMP280.

cap1xxx sense touches.

gpio-list prints out the function of each GPIO pin.

gpio-read reads a GPIO pin.

gpio-write sets a GPIO pin to low or high.

headers-list prints out the headers as found on the computer and print the functionality of each pin.

i2c-io communicates to an I²C device.

i2c-list lists all I²C buses.

ir reads from an IR receiver via LIRC.

led reads the state of a LED or change it.

lepton captures a single image, prints metadata about the camera state or triggers a calibration.

onewire-list lists all onewire buses and devices.

periph-info prints out information about the loaded periph drivers.

periph-smoketest runs all known smoke tests.

Package gpiosmoketest is leveraged by periph-smoketest to verify that basic GPIO pin functionality work.

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 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 spismoketest is leveraged by periph-smoketest to verify that an EEPROM device can be accessed on a SPI port.

spi-io writes to an SPI port data from stdin and outputs to stdout or writes arguments and outputs hex encoded output.

spi-list lists all SPI ports.

ssd1306 writes to a display driven by a ssd1306 controler.

thermal reads the state of thermal sensors exposed via sysfs.

tm1637 writes to a digits LED display.

Package conn defines core interfaces for protocols and connections.

Package conntest implements fakes for package conn.

Package display implements interfaces for visual output devices.

Package displaytest contains non-hardware devices implementations for testing or emulation purpose.

Package gpio defines digital pins.

Package gpioreg defines a registry for the known digital pins.

Package gpiostream defines digital streams.

Package gpiostreamtest enables testing device driver using gpiostream.PinIn or PinOut.

Package gpiotest is meant to be used to test drivers using fake Pins.

Package i2c defines the API to communicate with devices over the I²C protocol.

Package i2creg defines I²C bus registry to list buses present on the host.

Package i2ctest is meant to be used to test drivers over a fake I²C bus.

Package i2s will eventually define the API to communicate with devices over the I²S protocol.

Package ir defines InfraRed codes for use with a IR remote control.

Package jtag will eventually define the API to communicate with devices over the JTAG protocol.

Package mmr defines helpers to interact with devices exposing Memory Mapped Registers protocol.

Package onewire defines the API to communicate with devices over the Dallas Semiconductor / Maxim Integrated 1-wire protocol.

Package onewirereg defines a registry for onewire buses present on the host.

Package onewiretest is meant to be used to test drivers over a fake 1-wire bus.

Package physic declares types for physical input, outputs and measurement units.

Package pin declare well known pins.

Package pinreg is a registry for the physical headers (made up of pins) on a host.

Package spi defines the API to communicate with devices over the SPI protocol.

Package spireg defines the SPI registry for SPI ports discovered on the host.

Package spitest is meant to be used to test drivers over a fake SPI port.

Package uart will eventually define the API to communicate with devices over the UART protocol.

Package devices is a container for device drivers.

Package apa102 drives a strip of APA102 LEDs connected on a SPI port.

Package bmxx80 controls a Bosch BMP180/BME280/BMP280 device over I²C, or SPI for the BMx280.

Package bmx280smoketest is leveraged by periph-smoketest to verify that two BME280/BMP280, one over I²C, one over SPI, read roughly the same temperature, humidity and pressure.

Package cap1xxx controls a Microchip cap1105/cap1106/cap1114/cap1133/cap1126/cap1128/cap1166/cap1188 device over I²C.

Package ds18b20 interfaces to Dallas Semi / Maxim DS18B20 and MAX31820 1-wire temperature sensors.

Package ds248x controls a Maxim DS2483 or DS2482-100 1-wire interface chip over I²C.

Package lepton drives a FLIR Lepton Infra Red (IR) camera.

Package cci declares the Camera Command Interface to interact with a FLIR Lepton over I²C.

Package image14bit implements 14-bit per pixel images.

Package lirc implements InfraRed receiver support through native linux app lirc.

Package ssd1306 controls a 128x64 monochrome OLED display via a SSD1306 controller.

Package image1bit implements black and white (1 bit per pixel) 2D graphics.

Package ssd1306smoketest is leveraged by periph-smoketest to verify that two SSD1306, one over I²C, one over SPI, can display the same output.

Package tm1637 controls a TM1637 device over GPIO pins.

as7262 communicates with an as7262 continually reading the spectrum.

hd44780 writes to a text LCD screen.

ina219 communicates with an ina219 sensor reading voltage, current and power.

mcp9808 communicates with an mcp9808 sensor reading ambient temperature.

mfrc522 reads RFID tags.

mpu9250 calibrates and performs the self-test, then measures the acceleration continuously.

nrzled writes to a strip of LEDs using the NRZ protocol.

pca9548 scans the 8 ports of a pca9548 i2c multiplexer for other i2c devices.

periph-web runs a web server exposing periph's state.

Package analog defines analog pins, both digital to analog converter (DAC) and analog to digital converter (ADC).

Package gpioutil includes utilities to filter or augment GPIOs.

Package uart defines the UART protocol.

Package uartreg defines the UART registry for UART ports discovered on the host.

Package ads1x15 controls ADS1015/ADS1115 Analog-Digital Converters (ADC) via I²C interface.

Package as7262 controls an AMS 6 channel visible spectral sensor via an i2c interface.

Package bh1750 controls a ROHM BH1750 ambient light sensor, over an i2c bus.

Package bitbang implements conn by banging on the bits (GPIO pins).

Package ccs811 controls CCS811 Volatile Organic Compounds sensor via I²C interface.

Package epd controls Waveshare e-paper series displays.

Package hd44780 controls the Hitachi LCD display chipset HD-44780

Package ht16k33 implements interfacing code to Holtek HT16K33 Alphanumeric 16x8 LED driver.

Package hx711 implements an interface to the 24-bits HX711 analog to digital converter.

Package ina219 controls a Texas Instruments ina219 high side current, voltage and power monitor IC over an i2c bus.

Datasheet

Package mcp9808 controls a Microchip MCP9808 digital I²C temperature sensor.

Package mfrc522 controls a Mifare RFID card reader.

Package commands contains the command that a MFRC522 supports.

Package mpu9250 MPU-9250 is a 9-axis MotionTracking device that combines a 3-axis gyroscope, 3-axis accelerometer, 3-axis magnetometer and a Digital Motion Processor™ (DMP)

Package nrzled is a driver for LEDs ws2811/ws2812/ws2812b and compatible devices like sk6812 and ucs1903 that uses a single wire NRZ encoded communication protocol.

Package pca9548 is a driver for an 8 port I²C multiplexer that is available from multiple vendors.

Package pca9685 includes utilities to controls pca9685 module and servo motors.

Package piblaster implements interfacing code is piblaster.

Package rainbowhat implements interfacing code to Pimoroni's Rainbow hat.

Package sn3218 controls a SN3218 LED driver with 18 LEDs over an i2c bus.

Package unicornhd implements interfacing code to Pimoroni's Unicorn HD hat.

Package driverskeleton is an example that can be copy pasted to help write a new driver, either in devices/ or in host/.

Package pru exposes the Programmable Real-Time Unit Subsystem and Industrial Communication Subsystem (PRU-ICSS) functionality found on many Texas Instruments processors.

Package serial implements cross platform UART support exposed by the operating system.

Package host defines the host itself.

Package allwinner exposes the GPIO functionality that is common to all AllWinner processors.

Package allwinnersmoketest verifies that allwinner specific functionality work.

Package am335x exposes functionality for the Texas Instruments Sitara AM335x processor family.

Package bcm283x exposes the BCM283x GPIO functionality.

Package bcm283xsmoketest verifies that bcm283x specific functionality work.

Package beagle regroups subpackages containing BeagleBoard/BeagleBone board family headers definition.

Package black implements headers for the BeagleBone Black and BeagleBone Black Wireless micro-computers.

Package bone implements headers J1, P8 and P9 found on many (but not all) BeagleBone micro-computer.

Package green implements headers for the BeagleBone Green and BeagleBone Green Wireless micro-computers.

Package chip contains header definitions for NextThing Co's C.H.I.P. board.

Package chipsmoketest is leveraged by periph-smoketest to verify that basic CHIP specific functionality works.

Package cpu implements functions relating to the host CPU itself.

Package distro implements common functionality to auto-detect features on the host; generally about linux distributions.

Package fs provides access to the file system on the host.

Package odroidc1 contains header definitions for Hardkernel's ODROID C0, C1, and C1+ boards.

Package odroidc1smoketest is leveraged by periph-smoketest to verify that basic ODROID-C1 specific functionality works.

Package pine64 contains Pine64 hardware logic.

Package pmem implements handling of physical memory for user space programs.

Package rpi contains Raspberry Pi hardware logic.

Package sysfs implements a sane library to interact with sysfs provided hardware access.

Package sysfssmoketest verifies that sysfs specific functionality work.

Package videocore interacts with the VideoCore GPU found on bcm283x.