Coder Social home page Coder Social logo

pinout-xyz / pinout.xyz Goto Github PK

View Code? Open in Web Editor NEW
677.0 677.0 197.0 55.41 MB

Source files for the Raspberry Pi Pinout documentation website.

Home Page: http://pinout.xyz/

License: Other

Makefile 0.13% Python 11.34% JavaScript 3.09% CSS 4.60% HTML 77.58% Shell 0.79% Dockerfile 0.03% SCSS 2.46%

pinout.xyz's People

Contributors

5p4k avatar abelectronicsuk avatar andrewdorey avatar archieroques avatar bennuttall avatar combs avatar dadosch avatar epimetheus89 avatar extrapixel avatar flatmax avatar francesco-vannini avatar gadgetoid avatar garatronic avatar ikergarcia avatar joshualowe1002 avatar karrika avatar lurch avatar maslor avatar mmame avatar peterblazejewicz avatar plasmadancom avatar rdmueller avatar roguem avatar ryanteck avatar saucompeng avatar scottamain avatar smileyn64 avatar tuftii avatar ulbricht-inr avatar uugear avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

pinout.xyz's Issues

Mouseover area is wrong for odd pins

Something I just noticed - don't know if it's been like that for ages, or is only a recent problem...

On http://pinout.xyz if I mouse-hover over "BCM4" then BCM4 and physical pin 7 get highlighted. If I mouse-hover over "BCM14" then BCM14 and physical pin 8 get highlighted. If I mouse-hover over the pin-number "7" then BCM4 and physical pin 7 get highlighted. If I mouse-hover over the pin-number "8" then BCM14 and physical pin 8 get highlighted. If I mouse-hover over the purple circular-pin next to the pin-number "8" then BCM14 and physical pin 8 get highlighted.
All as expected.

But if I mouse-hover over the green circular pin next to the pin-number "7" then BCM14 and physical pin 8 get highlighted! Tested in both Chrome and Firefox on Ubuntu 14.04 - both behave the same (for all the circular pins on the left-side of the pinout header).

PCM_C and PCM_D ?

Pin12 is labelled as PCM_C - it's conceivable that this could be an abbreviation of PCM_CLK (in which case why even abbreviate it?), but given the description on the page, it seems PWM0 might be a more useful label? (which is what e.g. http://raspi.tv/download/RPi.GPIO-Cheat-Sheet.pdf uses)

And Pin13 is labelled as PCM_D which seems to make no sense at all??

Should we reinstate which VCC / GND pins a board might use, if known?

It was never really an issue with HATs, but the headerless pHAT format opens up a variety of different ways you might connect one or more boards to the Pi.

I think knowing which VCC / GND pins a board uses ( since they may not always be consistent ) is useful, although I do agree with the original reasons for removing them- they're visually noisy in some cases.

So I'll put it to discussion. Should we reinstate them? And if so, how could they be implemented subtly.

Dependencies

Maybe a note could be added to the readme about the build dependencies?
On Ubuntu 14.04 I found (by trial&error) that I had to:

sudo apt-get install libyaml-dev
sudo pip install pyyaml
sudo pip install markdown

before make would run successfully.

Overlay files changelog

With more translators coming into the fold, I think it would be worth considering a changelog for the overlays somewhere in the github repo that all could refer to from time to time.

It wouldn't have to be extensive and mention minor changes or typos, and would be mostly to facilite any critical error fixing spreading across all subdomains.

I'm thinking of things like the Pi-Dac+ which required both fixes that could be ported to all translations by you or I, such as the pin assigments, as well as things a bit more subtle, yet important, that would affect the localised description (in this instance the note about some optional being free for GPIO use, if wanted). I guess there could be any other number of reasons in the future where localised information could be affected, this is just an example.

Obviously the en-GB would serve as master for this purpose. Thoughts?

1-wire is missing.

Can you add the 1-wire (default) pins?

I've got dtoverlay=w1-gpio in config.txt and a DS18B20 connected to GPIO4.

Board Categories

Still debatable, but I'm thinking something like:

  • Robotics & Motors
  • LED & Lighting
  • Displays
  • Audio & Video
  • Input & Controls
  • Sensors
  • Microcontrollers
  • Other

I'd also love to get images for every single board because they look so good as thumbnails, but that's going to be a honking great amount of work!

Sense HAT GPIO assignments are incorrect

https://www.raspberrypi.org/wp-content/uploads/2015/08/Sense-HAT-V1_0.pdf

The pin assignments on the site do not correspond to the actual functional implications.

SPI { pi, Atmel } is not used by default. It is used for production test and programming the Atmel. The LED matrix (framebuffer) is driven via I2C.

The joystick is not connected to { 23, 24, 25 }. The joystick is sampled by the Atmel and the "buttons" are accessible via the I2C interface. These pins have no function by default but are left connected for user-specified applications.

Build instructions

Hello,

I want to build the pages using generate-html.py.

I'm running python generate-html.py and python generate-html.py en-GB, but in both cases I get this error:

..after mappings..
Rendering pin pages...
Outputting page pin1_3v3_power
Traceback (most recent call last):
  File "generate-html.py", line 364, in <module>
    with open(os.path.join('output',lang,'pinout','{}.html'.format(pin_url)),'w') as f:
IOError: [Errno 2] No such file or directory: 'output/en-GB/pinout/pin1_3v3_power.html'

I'm assuimg I'm missing something.

Markdown module for python is already installed. Using python 2.7.6 on Mac OSX Yosemite if that'd matter.

Do I have to do something beforehand?

Can you please also share some build instructions?

Thanks in advance,

Missing translation policy / behaviour?

I see from https://github.com/Gadgetoid/Pinout2/tree/master/src/tr-TR/overlay that there's no Turkish translation (yet) for the sense-hat. This means when I go to http://pinout.xyz/pinout/sense_hat then there's no Turkish flag displayed (which makes sense, from one POV).

However, I also noticed that e.g. http://fr.pinout.xyz/pinout/spi and http://fr.pinout.xyz/pinout/raspberry_pi_dots are identical to the English versions (which makes sense from another POV).

IMHO it would be more consistent to either not link to a non-translated page, if that page hasn't been translated yet, or to automatically display a copy of the English page so that there are no 'missing pages' on the language subdomains. (Personally, I'd go for the latter option, so that Turkish vistors can see that there is a sense-hat page, it just hasn't been translated to their locale yet).

Sense HAT markup error

http://pinout.xyz/pinout/sense_hat displays "a 8×8 RGB LED matrix" - I dunno if this is because of Unicode conversion / markup issues (which need fixing), or whether it'd be better to edit the SenseHAT 'source-file' to use the non-Unicode x character?

Generating HTML procedure

when time permits, could you write up the procedure for generating HTML for local check of the Overlay (I assume you can make a local copy to preview translation work most notably)?

I guess a md is needed for less than apt people like myself :D

Typo(s) in german Translation of pinout/pin5_gpio3

Hi,

thanks for your service providing GPIO layouts in such a wonderful way. Too bad I found a spelling error in the german page https://de.pinout.xyz/pinout/pin5_gpio3:

"SCL ist der Clock oder Tackt Anschluss des I2C-Bus des Pi. mehr über I2C."

It shouldn't say "Tackt" but "Takt" which is the same word for the music beat. For further correction of compount words (incl. Omission dash) and uppercase of the sentence's first letter of the second sentence I propose the following (changes shown with markdown):

"SCL ist der Clock- oder Taktanschluss des I2C-Bus des Pi. Mehr über I2C."

Thanks :)

Strange navigation sequence

If I go to http://pinout.xyz/ and then click on the French flag, it takes me to http://fr.pinout.xyz/
If I then click on the "Raspberry Pinout" logo in the top-left corner, then it takes me to http://fr.pinout.xyz/pinout and all the flag icons at the top right suddenly disappear!

And similarly, if I manually browse to http://pinout.xyz/pinout/ I get a page where the flag icons display the 'broken image' icon, and if I manually browse to http://pinout.xyz/pinout (or http://fr.pinout.xyz/pinout/ ) I get "Not Found".

IMHO it'd make sense for http://pinout.xyz/pinout and http://pinout.xyz/pinout/ to redirect to http://pinout.xyz/ , and for http://fr.pinout.xyz/pinout and http://fr.pinout.xyz/pinout/ to redirect to http://fr.pinout.xyz/ .
Or if that's not possible, maybe the page that gets displayed at http://pinout.xyz/ should also get automatically copied to http://pinout.xyz/pinout and http://pinout.xyz/pinout/ .

OTOH (and at the risk of breaking any bookmarks that people may have made), is having everything in a 'pinout' subdirectory (e.g. http://pinout.xyz/pinout/pin5_gpio3 and http://pinout.xyz/pinout/uart and http://pinout.xyz/pinout/sense_hat ) even useful in the first place? I guess we could either strip out the subdirectory (e.g. http://pinout.xyz/pin5_gpio3 and http://pinout.xyz/uart and http://pinout.xyz/sense_hat ), or separate the files up by using more logically named subdirectories (e.g. http://pinout.xyz/pin/pin5_gpio3 and http://pinout.xyz/bus/uart and http://pinout.xyz/board/sense_hat ) ??

3.3V Current

The statement "The 3v3, 3.3 volt, supply pin on the Pi has a max available current of about 50 mA" is incorrect for the B+ and later boards. (It may have been true for earlier models). It is possible to draw up to 1A - less current required for GPIO, SD Card etc. 800mA is certainly possible (5V power permitting.)

Graphical Pinout

Just spotted the new graphic on http://pinout.xyz/ - nice! 👍

Just a couple of little suggestions, which you're obviously free to ignore if you wish:

  • IMHO the pink colouring on the BCM pins 8, 7 & 19 should extend outwards slightly to also cover the 'CE0', 'CE1' and 'MISO' labels. And the same for 'ID_SD' on BCM pin 0.
  • I think the diagram should definitely make clear that the SPI interface on BCM pins 10, 9, 11, 8 & 7 is actually different from the SPI interface on BCM pins 19, 20 & 21, and the pins from each can't be intermixed. Perhaps change the labels to SPI-0 and SPI-1 (or similar)? And maybe there should be a "fatter corner" (IYSWIM) on the pink blobs between BCM19 and BCM20 to make it clearer that they're a part of the same SPI block?
  • It might also be worth doing something similar to differentiate I2C-1 (BCM 2 & 3) from I2C-0 (BCM 0 & 1)
  • Perhaps the GND pins should have a white dot in the middle, like the diagram on the left of http://pinout.xyz/ has, rather than being completely black?
  • Could you get rid of the very thin pink line between BCM8 and BCM11? ;-)

Any plans for B Rev1.0 support?

I realise these are now 'defunct', but a note somewhere or other about the different BCM Pin numbers on the original B rev1 boards might be nice?

arduino-spi.md incomplete

I had left this one for a time my brain was functioning. I think it is today :-)

anyhow, I think you are missing something in there, specifically you reference a MakeFile but it is nowhere to be found.

What about just replacing the part of the page starting: 'This basic Makefile should get you started...' by

"You are now ready to compile the sketch. Visit http://pi.gadgetoid.com/article/building-the-pico-piduino for a run-through of the process!"

Question about setup in nginx

I was hoping to mirror Pinout on my raspberry pi home server running on nginx on a raspberry pi 2. I cloned Pinout2 to the /var/www/html/ directory, installed the python dependencies, then ran the generate-html.py script. When I try to view the pinout.html file generated, I see this,

pinout

Is there some additional dependency that needs to be installed for the site to work normally?

Localisation of URLs

Possibly more of a comment / question than an issue, but I was surprised to just notice that the Turkish version of http://pinout.xyz/pinout/ryanteck_motor_controller_board is actually http://tr.pinout.xyz/pinout/ryanteck_motor_kontrol_kart

Wouldn't it make sense for the URLs themselves to be non-translatable, so that the Turkish version of http://pinout.xyz/pinout/ryanteck_motor_controller_board is actually http://tr.pinout.xyz/pinout/ryanteck_motor_controller_board ?

This is obviously something that ought to be fixed (if you consider it worth "fixing") before lots of sites start linking directly to sub-pages on http://pinout.xyz :-)

structure of the YAML files

I think it would be good to have a 'version' info in the board YAML file. This would help in a number of ways but I'm thinking for my own needs to be able in the future to be able to assess which revision I might have translated.

so I guess something like 'Revision: datestamp' would be useful... can this be added?

Generating HTML error

Hello,

Firstly thanks for open-sourcing the codes of this project! I have translated all the files to Turkish, but when I try to generate HTML files in my native language I encounter an error:

python generate-html.py tr-TR                                     [±master]
Traceback (most recent call last):
  File "generate-html.py", line 336, in <module>
    overlays = map(load_overlay,overlays)
  File "generate-html.py", line 89, in load_overlay
    loaded['long_description'] = load_md('description/overlay/{}.md'.format(overlay))
  File "generate-html.py", line 158, in load_md
    html = markdown.markdown(open(filename).read(), extensions=['fenced_code'])
  File "build/bdist.macosx-10.10-intel/egg/markdown/__init__.py", line 494, in markdown
  File "build/bdist.macosx-10.10-intel/egg/markdown/__init__.py", line 359, in convert
UnicodeDecodeError: 'ascii' codec can't decode byte 0xc4 in position 71: ordinal not in range(128). -- Note: Markdown only accepts unicode input!

I think there has to be a setting for encoding and decoding.

Here's my fork, along with updated translations:

https://github.com/Ardakilic/Pinout2/

Have I done something wrong while translating?

I'd appreciate if you could investigate this.

Thanks!

full translation of overlays

I see that that some tags are interpreted with no control over the translation within the overlay files. For example:

Made by Ryanteck
Classic 26-pin
Uses 4 GPIO pins
More Information
Buy Now

... am I missing something or is that on your TODO?

site localisation issues

as noted on Twitter, the UK flag is very difficult to trigger once on the tr-TR
also the flags only appears at http://pi.gadgetoid.com/pinout-tr/pinout

... I think you only just added the functionality, so no rush, just wanted to report it in case you'd not realised. To be honest I'm not sure this is hugely important, presumably, once you've chosen your language you probably don't care to switch again?

linking to external resources

right now when a link breaks all subdomains need fixing. You can always pattern match / replace the repo as a whole, but that would mean putting the forks out of sync for reasons hopefully that could be avoided?

I think it would be worth considering having a master hook in the en-GB, or subdomain independent.

Unicorn HAT 'singular' issue

the Unicorn HAT only uses the PWM pin. This creates an issue for the 'uses X pins' string that then reads grammatically incorrect (in all LANG).

I'm not sure what the answer is, maybe just add the power pin required. This is not a terrible idea, since it uses the 5V, which is not necessarily common?

Translation

Do you need an english to portuguese (pt-PT) translation? Let me know if you do as I may have the time to work on it.

Mypifi ledboard cc gadgetoid

Red gpio 17 physical pin 11
Amber gpio 27 physical 13
Green gpio 9 physical 21
Button gpio 26 physical pin 26
Leds are all gpio.outs
Button is gpio.in

Adafruit Capacitive Touch HAT

Just came across your GPIO pinout page display (sounds scandalous) and was hoping there might be some help for the Adafruit Capacitive Touch HAT. This device sounds wickedly fun, especially when used with the 7" touch screen interface.

Web: https://www.adafruit.com/products/2340
pinout: https://learn.adafruit.com/mpr121-capacitive-touch-sensor-on-raspberry-pi-and-beaglebone-black/hardware

I'm aware of your backlog note, #84 (comment), but add this in case y'all get some time.

Incorrect/inconsistent voltages for Pi and Arduino

On this page, the page starts by stating the Pi has a 3.3v line and the Arduino, 5v.

Then, in the second paragraph, the text states converting the Pi's 5v line to the Arduino's 3.3v line with a voltage regulator.

I believe the first statement is backwards.

DiscoHAT addition

Hi, I am currently designing a light and sound control board called DiscoHAT (http://discohat.com). I would love to choose the pins in a way that would work well together with HAT boards providing sound in/out functionality.

There is a HAT board called Cirrus Logic Audio Card at Adafruit that sounds like a cool companion board to my DiscoHAT board. But the pins it uses are not known to me. Perhaps there is some "standard" pins for digital audio in/out. But I cannot find the info here.

The only thing I really need for DiscoHAT is UART TX and 8 GPIO pins. But which GPIO pins to choose? So far I have gone with wiringPi 2 to wiringPi 9. Does anyone have good advice? There is still time to pick the right pins for maximum compatibility with other HAT boards.

UART pin colours

Why are the UART pins given the same colour as the 3v3 power pins? IMHO they should be a different colour.

potential en-GB data review

references to wiringpi that may need review:
/pin-3.md
/pin-5.md
/overlay/spi.md
/overlay/uart.md
/overlay/piborg-ledborg.md

'use i2c' not displayed

if the pin declaration is as follows:

pin:
3:
mode: i2c
5:
mode: i2c

then the 'use i2c' tag is not displayed. It has to be this way:

pin:
'3':
mode: i2c
'5':
mode: i2c

I'm going to fix the boards overlays but presumably that is not intended.

RedBear IoT pHAT

Hi,

We are the RedBear Team and thanks for posting the pinout of our IoT pHAT on https://pinout.xyz/pinout/iot_hat

A few updates

  1. We have changed the name from “IoT HAT” to “IoT pHAT” since the Pi team said that the small form factor add-on board should not be called “HAT”.
  2. There are some changes about the pinout in the final board
  3. Our GitHub Repository is https://github.com/redbear/IoT_pHAT which has the latest information
  4. They are available on sale at https://store.redbear.cc/product/rpi.html

Thank you and keep up the good work

Regards
Chi-Hung

Drop the country part of the locale specification?

Given that the Readme itself says "At the moment cultures are not fully supported, so you can't have src/fr-CA ( sorry! ), and there are no plans for this.", and the domains themselves are set up like http://de.pinout.xyz/ and http://fr.pinout.xyz/ ; would it make things 'simpler' if e.g. https://github.com/Gadgetoid/Pinout2/tree/master/src/de-DE was renamed to just de and https://github.com/Gadgetoid/Pinout2/tree/master/src/fr-FR was renamed to just fr ?

See also: https://en.wikipedia.org/wiki/ISO_639-1 and https://en.wikipedia.org/wiki/IETF_language_tag and all that good fun... ;-)

Include / Display i2c address

IMHO there should be a feature (i.e. built into the overlay 'data' itself, rather than just included in the 'markdown' part) for boards that "uses_i2c" to include the i2c address(es) the board uses. Which will be especially useful for non-HAT boards that use i2c and that can potentially be used together e.g. https://www.abelectronics.co.uk/
(although some of those boards include configurable i2c addresses, so I'm not sure (yet) what Pinout should do in those cases...)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.