pinout.vvzero.com/overlay
Phil Howard 1d33fa5539 Added description for dots 2015-03-23 20:08:30 +00:00
..
README.md Updated docs 2015-03-21 19:05:36 +00:00
arduino-spi.json New features, refinements, and basic Pi features 2015-03-21 22:16:06 +00:00
display-o-tron.json Tweaked CSS, added i2c to dot3k and i2c detection, added LEDborg 2015-03-21 23:40:38 +00:00
dots.json Added description for dots 2015-03-23 20:08:30 +00:00
explorer-hat-pro.json Added new boards, title and description merge tags and extra wiringpi pins 2015-03-22 19:02:36 +00:00
explorer-hat.json GitHub and Buy Now links, rtk0000001 description, updated README 2015-03-21 23:04:31 +00:00
i2c.json New features, refinements, and basic Pi features 2015-03-21 22:16:06 +00:00
piborg-ledborg.json Tweaked CSS, added i2c to dot3k and i2c detection, added LEDborg 2015-03-21 23:40:38 +00:00
pibrella.json New features, refinements, and basic Pi features 2015-03-21 22:16:06 +00:00
piglow.json Added new boards, title and description merge tags and extra wiringpi pins 2015-03-22 19:02:36 +00:00
rtk-000-001.json Added RTK RPi MCB 2015-03-21 22:27:41 +00:00
skywriter-hat.json Added new boards, title and description merge tags and extra wiringpi pins 2015-03-22 19:02:36 +00:00
spi.json New features, refinements, and basic Pi features 2015-03-21 22:16:06 +00:00
uart.json New features, refinements, and basic Pi features 2015-03-21 22:16:06 +00:00
unicorn-hat.json Added new boards, title and description merge tags and extra wiringpi pins 2015-03-22 19:02:36 +00:00
wiringpi.json Added new boards, title and description merge tags and extra wiringpi pins 2015-03-22 19:02:36 +00:00

README.md

#Pinout Overlays

A Pinout overlay describes the functions of the Raspberry Pi pins for a specific board.

An overlay is constructed from a JSON file and, optionally, a markdown file containing an extended long-description.

##JSON Format

The JSON overlay file must include a name, manufacturer name, URL, description and a "pin" array defining all the pins that the board uses.

If a counterpart .md file is present in description/overlay it will be used for the long description.

The pin array must list each pin by its physical location, and include at least a "name" describing the function of that pin.

Optionally each pin definition can include a "mode" flag, which defines the pin as an "input" or an "output".

A pin can also have an "active" value, which defines it as "high" or active "low".

I2C and SPI pins should be included if your board uses them, however they will generally be intepreted as being shared and usable with muliple boards unless you explicitly define them as being an "input" or "output".

Example:

{
	"name": "Explorer HAT",
	"manufacturer": "Pimoroni",
	"url": "https://github.com/pimoroni/pibrella",
	"description": "An all-in-one light, input and output add-on board.",
	"pin": {
		"7": {
			"name": "Green LED"
		},
		"11": {
			"name": "Yellow LED"
		}
	}
}