From bbe5f62be0c84afec1b0125d6e746af5432d6da4 Mon Sep 17 00:00:00 2001 From: Garage Tech Date: Tue, 15 Nov 2016 22:12:10 +0000 Subject: [PATCH] Update template.md PaPiRus HAT --- draft/overlay/template.md | 114 ++++++++++++++++++++++++-------------- 1 file changed, 72 insertions(+), 42 deletions(-) diff --git a/draft/overlay/template.md b/draft/overlay/template.md index 3479bd9..203fd74 100644 --- a/draft/overlay/template.md +++ b/draft/overlay/template.md @@ -1,18 +1,18 @@ -#my add-on board +#PaPiRus ePaper eInk display +*Raspberry Pi HAT compliant design +*Interchangeable screen sizes (1.44", 2.0" or 2.7") +*32MBit Flash Memory +*Battery Backed Real Time Clock (CR2032 battery included) +*Easy plug and play operation with onboard EEPROM +*Digital temperature sensor and thermal watchdog +*GPIO breakout connector and solder pads +*Optional reset pin header (for wake on alarm with RTC) +*4 x optional slimline switches on top -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. +Before using PaPiRus, do not forget to enable the SPI interface! -The overlay itself uses the following fields, some of which are mandatory, as noted below: +To get the HAT set up and ready to go you can use the one-line product installer: -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 'external', '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. +```bash +curl -sSL https://goo.gl/i1Imel | sudo bash +```