45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
|
<!--
|
||
|
|
---
|
||
|
|
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
|