new draft folder for WIP boards and template
This commit is contained in:
RogueM
parent
1aba125a18
commit
acf8a1c45d
|
|
@ -0,0 +1,18 @@
|
|||
#Pinout Overlays
|
||||
|
||||
A Pinout overlay describes the functions of the Raspberry Pi pins for a specific board.
|
||||
An overlay is specified by a Markdown file containing mandatory and optional fields as well as an extended long-description.
|
||||
|
||||
The Markdown overlay file must include as a minimum a name, class, type, formfactor, manufacturer, (short) description, product url, and last but not least an array defining all the pins that the board uses.
|
||||
|
||||
A long description is also highly desirable so that visitors to the site can get an introduction to the add-on boards featured on the site if they are not familar with them.
|
||||
|
||||
Note that 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 'direction', which defines the pin as an input or an output. A pin can also have an 'active' value, which defines it as active 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.
|
||||
|
||||
Power pins and EEPROM should specifically be excluded, but specifying the power and eeprom fields are highly recommended if that info is known.
|
||||
|
||||
All of the above is further expended in the overlay template.md. We recommend you use this template as a starting point for any new add-on board submission and add or remove fields as required.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 3.1 KiB |
|
|
@ -0,0 +1,51 @@
|
|||
<!--
|
||||
---
|
||||
name: board name
|
||||
class: category
|
||||
type: application
|
||||
formfactor: Custom
|
||||
image: board image
|
||||
manufacturer: made by
|
||||
description: what it is
|
||||
url: https://myaddon.com
|
||||
github: https://github.com/myaddonrepo.com
|
||||
buy: http://shopformyaddon.com
|
||||
pincount: 26
|
||||
eeprom: no
|
||||
power: 3v3,5v
|
||||
pin:
|
||||
'3':
|
||||
mode: i2c
|
||||
'5':
|
||||
mode: i2c
|
||||
i2c:
|
||||
'0x00':
|
||||
name: device display name
|
||||
device: chip name
|
||||
-->
|
||||
#my add-on board
|
||||
|
||||
Use this section to provide additional information such as features, technical parts, install requirements, etc. Please keep this section to the point and avoid copy/paste of marketing blurb - the board's extended description should be primarily neutral and technical.
|
||||
|
||||
The overlay itself uses the following fields, some of which are mandatory, as noted below:
|
||||
|
||||
MANDATORY
|
||||
* name: the board name as it will appear at pinout.xyz
|
||||
* class: the class the overlay falls in, 'board' is the most common (use that if in doubt).
|
||||
* type: the typical applications of the board, i.e 'lcd' (use 'other' if in doubt). If multiple types apply, use a comma separated list (for example, 'adc,motor'). The keywords submitted will be used to filter boards on the site so don't include anything but tags that are relevant to the key functionality of the board.
|
||||
* formfactor: the board's form factor. Valid values are Custom, HAT and pHAT. Note that an EEPROM is required for HAT specs, use Custom if that is not the case.
|
||||
* manufacturer: the manufacturer's name.
|
||||
* description: a description of what the add-on board provides.
|
||||
* url: the main URL for the product providing detailed technical information about the board.
|
||||
* pin: an array of the pins used. Do not specify power or EEPROM pins as part of the array!
|
||||
|
||||
DESIRABLE
|
||||
* pincount: the header pin count, typically 26 or 40 but shims/custom boards are acceptable.
|
||||
* eeprom: whether the board includes an eeprom (required by 'HAT' specs!).
|
||||
* power: the supply logic required by the board. Valid values are 3v3, 5v and 3v3,5v.
|
||||
* i2c: if the board uses i2c, a list of the bus address(es) and device(s) identification.
|
||||
|
||||
OPTIONAL
|
||||
* image: a top-down image of the board as png with transparency or appropriate placeholder (see image template in board directory).
|
||||
* github: github repository address.
|
||||
* buy: URL where the board can be purchased.
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
#Pinout Overlays
|
||||
|
||||
A Pinout overlay describes the functions of the Raspberry Pi pins for a specific board.
|
||||
An overlay is specified by a Markdown file containing mandatory and optional fields as well as an extended long-description.
|
||||
|
||||
The Markdown overlay file must include as a minimum a "name", "manufacturer", (short) "description", main "url", and last but not least a "pin" array defining all the pins that the board uses. It is also recommended to specify the header "pincount" and board "formfactor", as well as whether the board includes an "eeprom" (for us to ensure the HAT specifications are respected where appropriate).
|
||||
|
||||
A long description is also highly desirable so that visitors to the site can get an introduction to the add-on boards featured on the site if they are not familar with them.
|
||||
|
||||
Note that 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 active "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".
|
||||
|
||||
Power pins and EEPROM should specifically be excluded, but specifying the "power" and "eeprom" fields are highly recommended if that info is known (please check the board schematic, this info is typically not difficult to find!)
|
||||
|
||||
See the overlay template.md for more information. We recommend you use this template as a starting point for any new add-on board submission.
|
||||
|
|
@ -1,52 +0,0 @@
|
|||
<!--
|
||||
---
|
||||
name: board name
|
||||
class: category
|
||||
type: application
|
||||
formfactor: Custom
|
||||
image: board image
|
||||
manufacturer: made by
|
||||
description: what it is
|
||||
url: https://myaddon.com
|
||||
github: https://github.com/myaddonrepo.com
|
||||
buy: http://shopformyaddon.com
|
||||
pincount: 26
|
||||
eeprom: no
|
||||
power: 3v3,5v
|
||||
pin:
|
||||
'3':
|
||||
mode: i2c
|
||||
'5':
|
||||
mode: i2c
|
||||
i2c:
|
||||
'0x00':
|
||||
name: device display name
|
||||
device: chip name
|
||||
-->
|
||||
#my add-on board
|
||||
|
||||
Use this section to provide additional information such as fonctionality, technical parts, install requirements, etc
|
||||
The overlay itself uses the following fields, some of which are mandatory, as noted below:
|
||||
|
||||
MANDATORY
|
||||
name: the board name as it will appear in the board selection menu at pinout.xyz
|
||||
class: the class the overlay falls in, 'board' is the most common (use that if in doubt).
|
||||
type: the typical applications of the board, i.e 'lcd' (use 'other' if in doubt).
|
||||
If multiple types apply, use a comma separated list (for example, 'adc,motor').
|
||||
The keywords submitted will be used to filter boards at pinout.xyz so don't include anything but tags that are relevant to the key functionality of the board.
|
||||
formfactor: the board's form factor. Valid values are Custom, HAT and pHAT.
|
||||
manufacturer: the manufacturer's name.
|
||||
description: a short description of what the add-on board provides.
|
||||
url: the main URL for the product providing detailed technical information about the board.
|
||||
pin: an array of the pins used. Do not specify power or EEPROM pins as part of the array!
|
||||
|
||||
DESIRABLE
|
||||
pincount: the header pin count, typically 26 or 40 but shims/custom boards are acceptable.
|
||||
eeprom: whether the board includes an eeprom (required by 'HAT' specs!).
|
||||
power: the supply logic required by the board. Valid values are 3v3, 5v and 3v3,5v.
|
||||
i2c: if the board uses i2c, a list of the bus address(es) and device(s) identification.
|
||||
|
||||
OPTIONAL
|
||||
image: a top-down image of the board as png with transparency (or placeholder).
|
||||
github: github repository address.
|
||||
buy: URL where the board can be purchased.
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
<!--
|
||||
---
|
||||
name: board name
|
||||
manufacturer: made by
|
||||
description: what it is
|
||||
url: https://myaddon.com
|
||||
github: https://github.com/myaddonrepo.com
|
||||
buy: http://shopformyaddon.com
|
||||
formfactor: Custom
|
||||
pincount: 26
|
||||
eeprom: no
|
||||
power: 3v3,5v
|
||||
pin:
|
||||
'3':
|
||||
mode: i2c
|
||||
'5':
|
||||
mode: i2c
|
||||
i2c:
|
||||
'0x00':
|
||||
name: device display name
|
||||
device: chip name
|
||||
-->
|
||||
#my add-on board
|
||||
|
||||
Use this section to provide additional information such as fonctionality, technical parts, install requirements, etc
|
||||
The overlay itself uses the following fields, some of which are mandatory, as noted below:
|
||||
|
||||
MANDATORY
|
||||
name: the board name as it will appear in the board selection menu at pinout.xyz
|
||||
manufacturer: the manufacturer's name
|
||||
description: a short description of what the add-on board provides
|
||||
url: the main URL for the product providing detailed technical information about the board
|
||||
pin: an array of the pins used. Do not specify power or EEPROM pins as part of the array!
|
||||
|
||||
DESIRABLE
|
||||
formfactor: the board's form factor. Valid values currently are Custom, HAT and pHAT.
|
||||
pincount: the header pin count, typically 26 or 40 but shims/custom boards are acceptable.
|
||||
eeprom: whether the board includes an eeprom (required by 'HAT' specs!)
|
||||
power: the supply logic required by the board. Valid values are 3v3, 5v and 3v3,5v.
|
||||
i2c: if the board uses i2c, a list of the bus address(es) and device(s) identification
|
||||
|
||||
OPTIONAL
|
||||
github: github repository address
|
||||
buy: URL where the board can be purchased
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
<!--
|
||||
---
|
||||
name: board name
|
||||
manufacturer: made by
|
||||
description: what it is
|
||||
url: https://myaddon.com
|
||||
github: https://github.com/myaddonrepo.com
|
||||
buy: http://shopformyaddon.com
|
||||
formfactor: Custom
|
||||
pincount: 26
|
||||
eeprom: no
|
||||
power: 3v3,5v
|
||||
pin:
|
||||
'3':
|
||||
mode: i2c
|
||||
'5':
|
||||
mode: i2c
|
||||
i2c:
|
||||
'0x00':
|
||||
name: device display name
|
||||
device: chip name
|
||||
-->
|
||||
#my add-on board
|
||||
|
||||
Use this section to provide additional information such as fonctionality, technical parts, install requirements, etc
|
||||
The overlay itself uses the following fields, some of which are mandatory, as noted below:
|
||||
|
||||
MANDATORY
|
||||
name: the board name as it will appear in the board selection menu at pinout.xyz
|
||||
manufacturer: the manufacturer's name
|
||||
description: a short description of what the add-on board provides
|
||||
url: the main URL for the product providing detailed technical information about the board
|
||||
pin: an array of the pins used. Do not specify power or EEPROM pins as part of the array!
|
||||
|
||||
DESIRABLE
|
||||
formfactor: the board's form factor. Valid values currently are Custom, HAT and pHAT.
|
||||
pincount: the header pin count, typically 26 or 40 but shims/custom boards are acceptable.
|
||||
eeprom: whether the board includes an eeprom (required by 'HAT' specs!)
|
||||
power: the supply logic required by the board. Valid values are 3v3, 5v and 3v3,5v.
|
||||
i2c: if the board uses i2c, a list of the bus address(es) and device(s) identification
|
||||
|
||||
OPTIONAL
|
||||
github: github repository address
|
||||
buy: URL where the board can be purchased
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
<!--
|
||||
---
|
||||
name: board name
|
||||
manufacturer: made by
|
||||
description: what it is
|
||||
url: https://myaddon.com
|
||||
github: https://github.com/myaddonrepo.com
|
||||
buy: http://shopformyaddon.com
|
||||
formfactor: Custom
|
||||
pincount: 26
|
||||
eeprom: no
|
||||
power: 3v3,5v
|
||||
pin:
|
||||
'3':
|
||||
mode: i2c
|
||||
'5':
|
||||
mode: i2c
|
||||
i2c:
|
||||
'0x00':
|
||||
name: device display name
|
||||
device: chip name
|
||||
-->
|
||||
#my add-on board
|
||||
|
||||
Use this section to provide additional information such as fonctionality, technical parts, install requirements, etc
|
||||
The overlay itself uses the following fields, some of which are mandatory, as noted below:
|
||||
|
||||
MANDATORY
|
||||
name: the board name as it will appear in the board selection menu at pinout.xyz
|
||||
manufacturer: the manufacturer's name
|
||||
description: a short description of what the add-on board provides
|
||||
url: the main URL for the product providing detailed technical information about the board
|
||||
pin: an array of the pins used. Do not specify power or EEPROM pins as part of the array!
|
||||
|
||||
DESIRABLE
|
||||
formfactor: the board's form factor. Valid values currently are Custom, HAT and pHAT.
|
||||
pincount: the header pin count, typically 26 or 40 but shims/custom boards are acceptable.
|
||||
eeprom: whether the board includes an eeprom (required by 'HAT' specs!)
|
||||
power: the supply logic required by the board. Valid values are 3v3, 5v and 3v3,5v.
|
||||
i2c: if the board uses i2c, a list of the bus address(es) and device(s) identification
|
||||
|
||||
OPTIONAL
|
||||
github: github repository address
|
||||
buy: URL where the board can be purchased
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
<!--
|
||||
---
|
||||
name: board name
|
||||
manufacturer: made by
|
||||
description: what it is
|
||||
url: https://myaddon.com
|
||||
github: https://github.com/myaddonrepo.com
|
||||
buy: http://shopformyaddon.com
|
||||
formfactor: Custom
|
||||
pincount: 26
|
||||
eeprom: no
|
||||
power: 3v3,5v
|
||||
pin:
|
||||
'3':
|
||||
mode: i2c
|
||||
'5':
|
||||
mode: i2c
|
||||
i2c:
|
||||
'0x00':
|
||||
name: device display name
|
||||
device: chip name
|
||||
-->
|
||||
#my add-on board
|
||||
|
||||
Use this section to provide additional information such as fonctionality, technical parts, install requirements, etc
|
||||
The overlay itself uses the following fields, some of which are mandatory, as noted below:
|
||||
|
||||
MANDATORY
|
||||
name: the board name as it will appear in the board selection menu at pinout.xyz
|
||||
manufacturer: the manufacturer's name
|
||||
description: a short description of what the add-on board provides
|
||||
url: the main URL for the product providing detailed technical information about the board
|
||||
pin: an array of the pins used. Do not specify power or EEPROM pins as part of the array!
|
||||
|
||||
DESIRABLE
|
||||
formfactor: the board's form factor. Valid values currently are Custom, HAT and pHAT.
|
||||
pincount: the header pin count, typically 26 or 40 but shims/custom boards are acceptable.
|
||||
eeprom: whether the board includes an eeprom (required by 'HAT' specs!)
|
||||
power: the supply logic required by the board. Valid values are 3v3, 5v and 3v3,5v.
|
||||
i2c: if the board uses i2c, a list of the bus address(es) and device(s) identification
|
||||
|
||||
OPTIONAL
|
||||
github: github repository address
|
||||
buy: URL where the board can be purchased
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
<!--
|
||||
---
|
||||
name: board name
|
||||
manufacturer: made by
|
||||
description: what it is
|
||||
url: https://myaddon.com
|
||||
github: https://github.com/myaddonrepo.com
|
||||
buy: http://shopformyaddon.com
|
||||
formfactor: Custom
|
||||
pincount: 26
|
||||
eeprom: no
|
||||
power: 3v3,5v
|
||||
pin:
|
||||
'3':
|
||||
mode: i2c
|
||||
'5':
|
||||
mode: i2c
|
||||
i2c:
|
||||
'0x00':
|
||||
name: device display name
|
||||
device: chip name
|
||||
-->
|
||||
#my add-on board
|
||||
|
||||
Use this section to provide additional information such as fonctionality, technical parts, install requirements, etc
|
||||
The overlay itself uses the following fields, some of which are mandatory, as noted below:
|
||||
|
||||
MANDATORY
|
||||
name: the board name as it will appear in the board selection menu at pinout.xyz
|
||||
manufacturer: the manufacturer's name
|
||||
description: a short description of what the add-on board provides
|
||||
url: the main URL for the product providing detailed technical information about the board
|
||||
pin: an array of the pins used. Do not specify power or EEPROM pins as part of the array!
|
||||
|
||||
DESIRABLE
|
||||
formfactor: the board's form factor. Valid values currently are Custom, HAT and pHAT.
|
||||
pincount: the header pin count, typically 26 or 40 but shims/custom boards are acceptable.
|
||||
eeprom: whether the board includes an eeprom (required by 'HAT' specs!)
|
||||
power: the supply logic required by the board. Valid values are 3v3, 5v and 3v3,5v.
|
||||
i2c: if the board uses i2c, a list of the bus address(es) and device(s) identification
|
||||
|
||||
OPTIONAL
|
||||
github: github repository address
|
||||
buy: URL where the board can be purchased
|
||||
Loading…
Reference in New Issue