From 11c01a7ecc8f4d8ffba30b547849fc2816e3b3a1 Mon Sep 17 00:00:00 2001 From: RogueM Date: Mon, 9 Nov 2015 08:49:57 +0000 Subject: [PATCH] various changes to pin descriptions + overlay changelog --- src/{en-GB/overlay => }/README.md | 0 src/changelog.md | 28 +++++++++++++++++++++ src/en-GB/pin/pin-10.md | 6 +++-- src/en-GB/pin/pin-27.md | 2 -- src/en-GB/pin/pin-3.md | 19 -------------- src/en-GB/pin/pin-5.md | 13 +--------- src/en-GB/pin/pin-8.md | 6 +++-- src/fr-FR/overlay/README.md | 41 ------------------------------- 8 files changed, 37 insertions(+), 78 deletions(-) rename src/{en-GB/overlay => }/README.md (100%) create mode 100644 src/changelog.md delete mode 100644 src/fr-FR/overlay/README.md diff --git a/src/en-GB/overlay/README.md b/src/README.md similarity index 100% rename from src/en-GB/overlay/README.md rename to src/README.md diff --git a/src/changelog.md b/src/changelog.md new file mode 100644 index 0000000..774cf03 --- /dev/null +++ b/src/changelog.md @@ -0,0 +1,28 @@ +#Overlays History +This document only logs the changes to the overlay files that are relevant for purposes of translations. See files history for further details! + +Nov 8, 2015 +- major tweaks to spi.md + +Nov 7, 2015 +- added sense-hat.md +- major tweaks to iqaudio-pi-dac.md + +Oct 17, 2015 +- added display-o-tron-hat.md +- added piano-hat.md + +Jun 25, 2015 +- major tweaks to iqaudio-pi-dac.md + +May 10, 2015 +- added iqaudio-pi-dac.md + +Apr 18, 2015 +- major tweaks to traffic-hat.md + +Apr 6, 2015 +- added traffic-hat.md + +Apr 1, 2015 +- total architectural change to embedded Yaml \ No newline at end of file diff --git a/src/en-GB/pin/pin-10.md b/src/en-GB/pin/pin-10.md index cc3b88f..d15a969 100644 --- a/src/en-GB/pin/pin-10.md +++ b/src/en-GB/pin/pin-10.md @@ -1,5 +1,7 @@ -This pin doubles up as the UART recieve pin, RXD. It's also commonly known as "Serial". By default your Pi will receive serial commands over this Pi and pass them into a Console, which gives you command-line control over your Pi using a Serial cable. +This pin doubles up as the UART recieve pin, RXD. It's also commonly known as "Serial" and, by default, will output a Console from your Pi that, with a suitable Serial cable, you can use to control your Pi via the command-line. -The UART pins, with an appropriate cable, are extremely useful for setting up a "headless" ( a Pi without a screen ) Pi and getting it connected to a network. +Thus, The UART pins are useful for setting up a "headless" Pi (a Pi without a screen) and getting it connected to a network. + +UART can also be extremely useful if you want to talk to Arduino or Propeller boards from your Pi, but you must make sure you disable the Serial Console in raspi-config first. [Learn more about UART](/pinout/uart) \ No newline at end of file diff --git a/src/en-GB/pin/pin-27.md b/src/en-GB/pin/pin-27.md index 7481216..1aa0b3e 100644 --- a/src/en-GB/pin/pin-27.md +++ b/src/en-GB/pin/pin-27.md @@ -1,3 +1 @@ -# HAT EEPROM Pins ID_SC and ID_SD - These pins are generally reserved for i2c communication with a HAT EEPROM. \ No newline at end of file diff --git a/src/en-GB/pin/pin-3.md b/src/en-GB/pin/pin-3.md index e7f14dd..0c066d9 100644 --- a/src/en-GB/pin/pin-3.md +++ b/src/en-GB/pin/pin-3.md @@ -4,22 +4,3 @@ It's easy to get started writing a digital HIGH or LOW to a GPIO pin, but you've * Run your script as root * Set your pin's mode to OUTPUT (1) - -Assuming you've installed WiringPi2-Python ( pip install wiringpi2 ) then try pasting the following into a .py file: - -```python -import wiringpi2 as wiringpi -HIGH = 1 -LOW = 0 -OUTPUT = 1 -INPUT = 0 -wiringpi.wiringPiSetup() -wiringpi.pinMode(8,OUTPUT) -wiringpi.digitalWrite(8,HIGH) -``` - -Then run it with: - -```bash -sudo python myscript.py -``` \ No newline at end of file diff --git a/src/en-GB/pin/pin-5.md b/src/en-GB/pin/pin-5.md index 55f1685..620c306 100644 --- a/src/en-GB/pin/pin-5.md +++ b/src/en-GB/pin/pin-5.md @@ -1,12 +1 @@ -SCL is one of the i2c pins on the Pi, [learn more about i2c](/pinout/i2c). - -```python -require 'wiringpi2' -HIGH = 1 -LOW = 0 -OUTPUT = 1 -INPUT = 0 -io = WiringPi::GPIO.new -io.pin_mode(9,OUTPUT) -io.digital_write(9,HIGH) -``` \ No newline at end of file +SCL is one of the i2c pins on the Pi, [learn more about i2c](/pinout/i2c). \ No newline at end of file diff --git a/src/en-GB/pin/pin-8.md b/src/en-GB/pin/pin-8.md index f4226ec..61500e3 100644 --- a/src/en-GB/pin/pin-8.md +++ b/src/en-GB/pin/pin-8.md @@ -1,5 +1,7 @@ -This pin doubles up as the UART transmit pin, thus the name TXD. It's also commonly known as "Serial" and, by default, will output a Console from your Pi that, with a suitable Serial cable, you can use to control your Pi via the command-line. +This pin doubles up as the UART transmit pin, TXD. It's also commonly known as "Serial" and, by default, will output a Console from your Pi that, with a suitable Serial cable, you can use to control your Pi via the command-line. -UART is also extremely useful if you want to talk to Arduino or Propeller boards from your Pi, but you must make sure you disable the Serial Console in raspi-config first. +Thus, The UART pins are useful for setting up a "headless" Pi (a Pi without a screen) and getting it connected to a network. + +UART can also be extremely useful if you want to talk to Arduino or Propeller boards from your Pi, but you must make sure you disable the Serial Console in raspi-config first. [Learn more about UART](/pinout/uart) \ No newline at end of file diff --git a/src/fr-FR/overlay/README.md b/src/fr-FR/overlay/README.md deleted file mode 100644 index ab5f112..0000000 --- a/src/fr-FR/overlay/README.md +++ /dev/null @@ -1,41 +0,0 @@ -#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: - -```json -{ - "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" - } - } -} -```