pinout.vvzero.com/src/en-GB/overlay
RogueM d74be0d819 adding sense HAT overlay
rough overlay (refinements to come) for Sense HAT
2015-11-07 15:48:10 +00:00
..
arduino-spi.md Total architectural change to embedded Yaml 2015-04-10 23:32:08 +01:00
display-o-tron-hat.md Piano hat and other adventures 2015-10-17 09:22:59 +01:00
display-o-tron.md Update display-o-tron.md 2015-10-14 15:05:01 +01:00
dots.md Total architectural change to embedded Yaml 2015-04-10 23:32:08 +01:00
explorer-hat-pro.md Added install data to explorer-hat-pro.md 2015-10-14 14:57:07 +01:00
explorer-hat.md Update explorer-hat.md 2015-10-28 13:37:29 +00:00
ground.md fixed a few spelling errors 2015-06-15 13:41:04 -04:00
i2c.md Total architectural change to embedded Yaml 2015-04-10 23:32:08 +01:00
iqaudio-pi-dac.md corrections and cleaning up 2015-11-06 17:42:12 +00:00
piano-hat.md Piano hat and other adventures 2015-10-17 09:22:59 +01:00
piborg-ledborg.md Total architectural change to embedded Yaml 2015-04-10 23:32:08 +01:00
pibrella.md Total architectural change to embedded Yaml 2015-04-10 23:32:08 +01:00
piglow.md Total architectural change to embedded Yaml 2015-04-10 23:32:08 +01:00
README.md Updated for better translation support 2015-03-25 23:26:46 +00:00
rtk-000-0001.md Total architectural change to embedded Yaml 2015-04-10 23:32:08 +01:00
sense-hat.md adding sense HAT overlay 2015-11-07 15:48:10 +00:00
skywriter-hat.md Update skywriter-hat.md 2015-10-14 15:16:56 +01:00
spi.md Total architectural change to embedded Yaml 2015-04-10 23:32:08 +01:00
traffic-hat.md Added print CSS, shortened Traffic HAT page 2015-04-18 22:27:03 +01:00
uart.md Total architectural change to embedded Yaml 2015-04-10 23:32:08 +01:00
unicorn-hat.md Update unicorn-hat.md 2015-10-28 13:18:08 +00:00
wiringpi.md Total architectural change to embedded Yaml 2015-04-10 23:32:08 +01:00

#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"
		}
	}
}