Merge branch 'docs/add-pinout-map' into 'master' (8465762f) · Commits · PoolPay Heidelberg / PoolPay

README.md

+25 −0

Original line number	Diff line number	Diff line
		@@ -25,6 +25,31 @@ Maintainer: Jakob Moser <moser@cl.uni-heidelberg.de>

		### NFC Reader

		#### Wiring

		Connect female-female cables to the RC522 module:

		\| Pin \| Color \|
		\| ---- \| -------- \|
		\| VCC \| 🩶 Gray \|
		\| RST \| 💜 Purple \|
		\| GND \| 💙 Blue \|
		\| MISO \| 💚 Green \|
		\| MOSI \| 💛 Yellow \|
		\| SCK \| 🧡 Orange \|
		\| NSS \| ❤️ Red \|
		\| IRQ \| 🤎 Brown \|

		<small>(interestingly enough, there is a gray heart, but no gray square emoji — all other colors would have squares)</small>

		Then, connect the cables to the Pi as described in this chart:

		![Connections between Pi and NFC Reader](./docs/nfc_wiring_static.png)

		<small>Image based on [Pinout.xyz](https://pinout.xyz) created by [@gadgetoid](https://fosstodon.org/@gadgetoid)</small>

		#### Configuration

		1. Open `sudo raspi-config`
		2. Go to “Interface Options”
		3. Go to “SPI”

docs/nfc_wiring_static.png

0 → 100644

+85.1 KiB

Loading image diff...

docs/wiring/nfc.html

0 → 100644

+282 −0

Original line number	Diff line number	Diff line
		<!DOCTYPE html>
		<html lang="en">

		<head>
		<meta charset="utf-8" />
		<title>Raspberry Pi GPIO Pinout</title>
		<link href="./pinout.scss.css" rel="stylesheet">
		<link href="./print.css" rel="stylesheet" media="print">
		<style>
		.pin {
		background: black !important;
		}

		.pin1 .pin {
		background: gray !important;
		}

		.pin6 .pin {
		background: blue !important;
		}

		.pin6 .pin {
		background: blue !important;
		}

		.pin18 .pin {
		background: rgb(165, 118, 42) !important;
		/* brown */
		}

		.pin22 .pin {
		background: purple !important;
		}

		.pin24 .pin {
		background: red !important;
		}

		.pin19 .pin {
		background: yellow !important;
		}

		.pin21 .pin {
		background: green !important;
		}

		.pin23 .pin {
		background: orange !important;
		}
		</style>
		</head>

		<body>
		<div id="container">
		<h1 class="logo"><a href="https://pinout.xyz/">MFRC522 Wiring</a></h1>

		<div id="leftcolumn">
		<nav id="gpio">
		<div id="pinbase"></div>
		<ul class="bottom">
		<li class="pin1 pow3v3"><a href="https://pinout.xyz/pinout/3v3_power" title="">
		<span class="default"><span class="phys">1</span> 3v3 Power</span><span
		class="pin"></span></a></li>
		<li class="pin3 gpio i2c"><a href="https://pinout.xyz/pinout/pin3_gpio2"
		title="Wiring Pi pin 8"><span class="default"><span class="phys">3</span> <span
		class="name">GPIO 2</span> <small>(I2C1 SDA)</small></span><span
		class="pin"></span></a></li>
		<li class="pin5 gpio i2c"><a href="https://pinout.xyz/pinout/pin5_gpio3"
		title="Wiring Pi pin 9"><span class="default"><span class="phys">5</span> <span
		class="name">GPIO 3</span> <small>(I2C1 SCL)</small></span><span
		class="pin"></span></a></li>
		<li class="pin7 gpio"><a href="https://pinout.xyz/pinout/pin7_gpio4" title="Wiring Pi pin 7">
		<span class="default"><span class="phys">7</span> <span class="name">GPIO 4</span>
		<small>(GPCLK0)</small></span><span class="pin"></span></a></li>
		<li class="pin9 gnd"><a href="https://pinout.xyz/pinout/ground" title=""><span class="default"><span
		class="phys">9</span> Ground</span><span class="pin"></span></a></li>
		<li class="pin11 gpio"><a href="https://pinout.xyz/pinout/pin11_gpio17"
		title="Wiring Pi pin 0"><span class="default"><span class="phys">11</span> <span
		class="name">GPIO 17</span></span><span class="pin"></span></a></li>
		<li class="pin13 gpio"><a href="https://pinout.xyz/pinout/pin13_gpio27"
		title="Wiring Pi pin 2"><span class="default"><span class="phys">13</span> <span
		class="name">GPIO 27</span></span><span class="pin"></span></a></li>
		<li class="pin15 gpio"><a href="https://pinout.xyz/pinout/pin15_gpio22"
		title="Wiring Pi pin 3"><span class="default"><span class="phys">15</span> <span
		class="name">GPIO 22</span></span><span class="pin"></span></a></li>
		<li class="pin17 pow3v3"><a href="https://pinout.xyz/pinout/3v3_power" title="">
		<span class="default"><span class="phys">17</span> 3v3 Power</span><span
		class="pin"></span></a></li>
		<li class="pin19 gpio spi"><a href="https://pinout.xyz/pinout/pin19_gpio10"
		title="Wiring Pi pin 12"><span class="default"><span class="phys">19</span> <span
		class="name">GPIO 10</span> <small>(SPI0 MOSI)</small></span><span
		class="pin"></span></a></li>
		<li class="pin21 gpio spi"><a href="https://pinout.xyz/pinout/pin21_gpio9"
		title="Wiring Pi pin 13"><span class="default"><span class="phys">21</span> <span
		class="name">GPIO 9</span> <small>(SPI0 MISO)</small></span><span
		class="pin"></span></a></li>
		<li class="pin23 gpio spi"><a href="https://pinout.xyz/pinout/pin23_gpio11"
		title="Wiring Pi pin 14"><span class="default"><span class="phys">23</span> <span
		class="name">GPIO 11</span> <small>(SPI0 SCLK)</small></span><span
		class="pin"></span></a></li>
		<li class="pin25 gnd"><a href="https://pinout.xyz/pinout/ground" title="">
		<span class="default"><span class="phys">25</span> Ground</span><span
		class="pin"></span></a>
		</li>
		<li class="pin27 gpio i2c"><a href="https://pinout.xyz/pinout/pin27_gpio0"
		title="Wiring Pi pin 30"><span class="default"><span class="phys">27</span> <span
		class="name">GPIO 0</span> <small>(EEPROM SDA)</small></span><span
		class="pin"></span></a></li>
		<li class="pin29 gpio"><a href="https://pinout.xyz/pinout/pin29_gpio5"
		title="Wiring Pi pin 21"><span class="default"><span class="phys">29</span> <span
		class="name">GPIO 5</span></span><span class="pin"></span></a></li>
		<li class="pin31 gpio"><a href="https://pinout.xyz/pinout/pin31_gpio6"
		title="Wiring Pi pin 22"><span class="default"><span class="phys">31</span> <span
		class="name">GPIO 6</span></span><span class="pin"></span></a></li>
		<li class="pin33 gpio"><a href="https://pinout.xyz/pinout/pin33_gpio13"
		title="Wiring Pi pin 23"><span class="default"><span class="phys">33</span> <span
		class="name">GPIO 13</span> <small>(PWM1)</small></span><span
		class="pin"></span></a></li>
		<li class="pin35 gpio pcm"><a href="https://pinout.xyz/pinout/pin35_gpio19"
		title="Wiring Pi pin 24"><span class="default"><span class="phys">35</span> <span
		class="name">GPIO 19</span> <small>(PCM FS)</small></span><span
		class="pin"></span></a></li>
		<li class="pin37 gpio"><a href="https://pinout.xyz/pinout/pin37_gpio26"
		title="Wiring Pi pin 25"><span class="default"><span class="phys">37</span> <span
		class="name">GPIO 26</span></span><span class="pin"></span></a></li>
		<li class="pin39 gnd"><a href="https://pinout.xyz/pinout/ground" title="">
		<span class="default"><span class="phys">39</span> Ground</span><span
		class="pin"></span></a>
		</li>
		</ul>
		<ul class="top">
		<li class="pin2 pow5v"><a href="https://pinout.xyz/pinout/5v_power" title="">
		<span class="default"><span class="phys">2</span> 5v Power</span><span
		class="pin"></span></a>
		</li>
		<li class="pin4 pow5v"><a href="https://pinout.xyz/pinout/5v_power" title="">
		<span class="default"><span class="phys">4</span> 5v Power</span><span
		class="pin"></span></a>
		</li>
		<li class="pin6 gnd"><a href="https://pinout.xyz/pinout/ground" title=""><span class="default"><span
		class="phys">6</span> Ground</span><span class="pin"></span></a></li>
		<li class="pin8 gpio uart"><a href="https://pinout.xyz/pinout/pin8_gpio14"
		title="Wiring Pi pin 15"><span class="default"><span class="phys">8</span> <span
		class="name">GPIO 14</span> <small>(UART TX)</small></span><span
		class="pin"></span></a></li>
		<li class="pin10 gpio uart"><a href="https://pinout.xyz/pinout/pin10_gpio15"
		title="Wiring Pi pin 16"><span class="default"><span class="phys">10</span> <span
		class="name">GPIO 15</span> <small>(UART RX)</small></span><span
		class="pin"></span></a></li>
		<li class="pin12 gpio pcm"><a href="https://pinout.xyz/pinout/pin12_gpio18"
		title="Wiring Pi pin 1"><span class="default"><span class="phys">12</span> <span
		class="name">GPIO 18</span> <small>(PCM CLK)</small></span><span
		class="pin"></span></a></li>
		<li class="pin14 gnd"><a href="https://pinout.xyz/pinout/ground" title="">
		<span class="default"><span class="phys">14</span> Ground</span><span
		class="pin"></span></a>
		</li>
		<li class="pin16 gpio"><a href="https://pinout.xyz/pinout/pin16_gpio23"
		title="Wiring Pi pin 4"><span class="default"><span class="phys">16</span> <span
		class="name">GPIO 23</span></span><span class="pin"></span></a></li>
		<li class="pin18 gpio"><a href="https://pinout.xyz/pinout/pin18_gpio24"
		title="Wiring Pi pin 5"><span class="default"><span class="phys">18</span> <span
		class="name">GPIO 24</span></span><span class="pin"></span></a></li>
		<li class="pin20 gnd"><a href="https://pinout.xyz/pinout/ground" title="">
		<span class="default"><span class="phys">20</span> Ground</span><span
		class="pin"></span></a>
		</li>
		<li class="pin22 gpio"><a href="https://pinout.xyz/pinout/pin22_gpio25"
		title="Wiring Pi pin 6"><span class="default"><span class="phys">22</span> <span
		class="name">GPIO 25</span></span><span class="pin"></span></a></li>
		<li class="pin24 gpio spi"><a href="https://pinout.xyz/pinout/pin24_gpio8"
		title="Wiring Pi pin 10"><span class="default"><span class="phys">24</span> <span
		class="name">GPIO 8</span> <small>(SPI0 CE0)</small></span><span
		class="pin"></span></a></li>
		<li class="pin26 gpio spi"><a href="https://pinout.xyz/pinout/pin26_gpio7"
		title="Wiring Pi pin 11"><span class="default"><span class="phys">26</span> <span
		class="name">GPIO 7</span> <small>(SPI0 CE1)</small></span><span
		class="pin"></span></a></li>
		<li class="pin28 gpio i2c"><a href="https://pinout.xyz/pinout/pin28_gpio1"
		title="Wiring Pi pin 31"><span class="default"><span class="phys">28</span> <span
		class="name">GPIO 1</span> <small>(EEPROM SCL)</small></span><span
		class="pin"></span></a></li>
		<li class="pin30 gnd"><a href="https://pinout.xyz/pinout/ground" title="">
		<span class="default"><span class="phys">30</span> Ground</span><span
		class="pin"></span></a>
		</li>
		<li class="pin32 gpio"><a href="https://pinout.xyz/pinout/pin32_gpio12"
		title="Wiring Pi pin 26"><span class="default"><span class="phys">32</span> <span
		class="name">GPIO 12</span> <small>(PWM0)</small></span><span
		class="pin"></span></a></li>
		<li class="pin34 gnd"><a href="https://pinout.xyz/pinout/ground" title="">
		<span class="default"><span class="phys">34</span> Ground</span><span
		class="pin"></span></a>
		</li>
		<li class="pin36 gpio"><a href="https://pinout.xyz/pinout/pin36_gpio16"
		title="Wiring Pi pin 27"><span class="default"><span class="phys">36</span> <span
		class="name">GPIO 16</span></span><span class="pin"></span></a></li>
		<li class="pin38 gpio pcm"><a href="https://pinout.xyz/pinout/pin38_gpio20"
		title="Wiring Pi pin 28"><span class="default"><span class="phys">38</span> <span
		class="name">GPIO 20</span> <small>(PCM DIN)</small></span><span
		class="pin"></span></a></li>
		<li class="pin40 gpio pcm"><a href="https://pinout.xyz/pinout/pin40_gpio21"
		title="Wiring Pi pin 29"><span class="default"><span class="phys">40</span> <span
		class="name">GPIO 21</span> <small>(PCM DOUT)</small></span><span
		class="pin"></span></a></li>
		</ul>
		</nav>
		<div id="legend">
		<div>
		<h2>Legend</h2>
		<p>Orientate your Pi with the GPIO on the right and the HDMI port(s) on the left.</p>
		<ul>
		<li class="gpio">
		<a href="https://pinout.xyz/pinout/wiringpi" title="GPIO (General Purpose IO)">
		<span class="default"></span>
		<span class="pin"></span> GPIO <small>(General Purpose IO)</small>
		</a>
		</li>
		<li class="spi">
		<a href="https://pinout.xyz/pinout/spi" title="SPI (Serial Peripheral Interface)">
		<span class="default"></span>
		<span class="pin"></span> SPI <small>(Serial Peripheral Interface)</small>
		</a>
		</li>
		<li class="i2c">
		<a href="https://pinout.xyz/pinout/i2c" title="I2C (Inter-integrated Circuit)">
		<span class="default"></span>
		<span class="pin"></span> I<sup>2</sup>C <small>(Inter-integrated Circuit)</small>
		</a>
		</li>
		<li class="uart">
		<a href="https://pinout.xyz/pinout/uart"
		title="UART (Universal Asynchronous Receiver/Transmitter)">
		<span class="default"></span>
		<span class="pin"></span> UART <small>(Universal Asynchronous
		Receiver/Transmitter)</small>
		</a>
		</li>
		<li class="pcm">
		<a href="https://pinout.xyz/pinout/pcm" title="PCM (Pulse Code Modulation)">
		<span class="default"></span>
		<span class="pin"></span> PCM <small>(Pulse Code Modulation)</small>
		</a>
		</li>
		<li class="gnd">
		<a href="https://pinout.xyz/pinout/ground" title="Ground">
		<span class="default"></span>
		<span class="pin"></span> Ground
		</a>
		</li>
		<li class="pow5v">
		<a href="https://pinout.xyz/pinout/5v_power" title="5v (Power)">
		<span class="default"></span>
		<span class="pin"></span> 5v <small>(Power)</small>
		</a>
		</li>
		<li class="pow3v3">
		<a href="https://pinout.xyz/pinout/3v3_power" title="3.3v (Power)">
		<span class="default"></span>
		<span class="pin"></span> 3.3v <small>(Power)</small>
		</a>
		</li>
		</ul>
		</div>
		<img src="./pi-orientation.png" width="196" height="297">
		</div>
		</div>

		<div class="footer">
		<p>Spotted an error, want to add your board's pinout? <a
		href="https://github.com/pinout-xyz/Pinout.xyz">Contribute to Pinout.xyz at GitHub</a></p>
		<p>Part of <a href="https://www.gadgetoid.com/">gadgetoid.com</a>. Maintained by <a
		href="https://fosstodon.org/@gadgetoid">@Gadgetoid@fosstodon.org</a>.</p>
		<p>Help make Pinout.xyz better- please sponsor me at <a href="https://ko-fi.com/gadgetoid">Ko-Fi</a>, <a
		href="https://github.com/sponsors/Gadgetoid">GitHub</a> or <a
		href="https://www.patreon.com/gadgetoid">Patreon</a></p>
		</div>
		</div>

		</body>

		</html>
		No newline at end of file

docs/wiring/pi-orientation.png

0 → 100644

+7.32 KiB

Loading image diff...

docs/wiring/pinout.scss.css

0 → 100644

+295 −0

Original line number	Diff line number	Diff line
		ul, li, a, body, h1, h2, h3, h4, h5, h6, p {
		margin: 0;
		padding: 0;
		text-decoration: none; }

		body {
		font-family: 'Roboto', sans-serif;
		font-weight: 500;
		font-size: 1.2em;
		background: #ffffff;
		color: #073642; }

		.logo {
		font-family: 'Roboto', sans-serif;
		width: 200px;
		font-size: 1.2em;
		line-height: 23px;
		cursor: pointer;
		position: absolute;
		left: 0px;
		top: 5px;
		z-index: 1;
		font-weight: 600;
		height: 61px; }
		.logo a {
		color: #073642;
		line-height: 22px; }
		.logo img {
		float: left;
		margin: 0px 5px 0px 0px;
		width: 45px; }
		.logo a:hover span, .logo a:hover, .logo a:hover span.out {
		color: #073642; }

		img.grayscale {
		filter: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg'><filter id='grayscale'><feColorMatrix type='matrix' values='0.3333 0.3333 0.3333 0 0 0.3333 0.3333 0.3333 0 0 0.3333 0.3333 0.3333 0 0 0 0 0 1 0'/></filter></svg>#grayscale");
		/* Firefox 10+, Firefox on Android */
		filter: gray;
		/* IE6-9 */
		-webkit-filter: grayscale(100%);
		/* Chrome 19+, Safari 6+, Safari 6+ iOS */ }

		#container {
		width: 1000px;
		margin: 0 auto;
		position: relative;
		padding-top: 4px; }


		/*
		Content Area
		*/
		h1, h2, h3, h4, h5, h6 {
		font-family: "Palatino Linotype", "Book Antiqua", Palatino, serif; }


		/*
		Footer
		*/
		.footer {
		clear: both;
		padding: 20px 0px;
		text-align: center; }
		.footer a {
		color: #5F8645; }

		/*
		GPIO nav
		*/
		nav {
		position: relative;
		width: 316px;
		margin-top: 64px; }

		#gpio {
		width: 496px;
		min-height: 493px;
		background: #5F8645; }
		#gpio:before {
		content: '';
		display: block;
		width: 58px;
		position: absolute;
		left: 219px;
		height: 493px;
		background: #073642;
		top: 0px; }
		#gpio ul {
		position: relative;
		top: 7px;
		list-style: none;
		display: block;
		width: 248px;
		float: left; }
		#gpio a {
		display: block;
		position: relative;
		font-size: 0.84em;
		line-height: 22px;
		height: 22px;
		margin-bottom: 2px;
		color: #E9E5D2;
		width: 248px; }
		#gpio .phys {
		color: #073642;
		font-size: 0.8em;
		opacity: 0.8;
		position: absolute;
		left: 32px;
		text-indent: 0; }
		#gpio .pin {
		display: block;
		border: 1px solid transparent;
		border-radius: 50%;
		width: 16px;
		height: 16px;
		background: #002B36;
		position: absolute;
		right: 4px;
		top: 2px; }
		#gpio .pin:after {
		content: '';
		display: block;
		border-radius: 100%;
		background: #FDF6E3;
		position: absolute;
		left: 5px;
		top: 5px;
		width: 6px;
		height: 6px; }
		#gpio .top li {
		text-indent: 56px; }
		#gpio .top a {
		border-top-left-radius: 13px;
		border-bottom-left-radius: 13px; }
		#gpio .top .overlay-ground .phys {
		padding-left: 31px;
		left: 0; }
		#gpio .top .pin {
		left: 4px;
		top: 2px; }
		#gpio .bottom a {
		text-indent: 10px;
		border-top-right-radius: 13px;
		border-bottom-right-radius: 13px; }
		#gpio .bottom .overlay-ground .phys {
		padding-right: 32px;
		right: 0; }
		#gpio .bottom .phys {
		text-align: right;
		left: auto;
		right: 32px; }
		#gpio .gnd a {
		color: rgba(233, 229, 210, 0.5); }
		#gpio:hover {
		color: rgba(6, 53, 65, 0.5); }
		#gpio a:hover,
		#gpio .active a {
		background: #f5f3ed;
		color: #063541; }
		#gpio li a small {
		font-size: 0.7em; }
		#gpio .overlay-pin a {
		background: #ebe6d3;
		color: #063541; }
		#gpio .overlay-pin a:hover {
		background: #f5f3ed;
		color: #063541; }
		#gpio .overlay-pin.gnd a {
		color: rgba(6, 53, 65, 0.5); }
		#gpio .overlay-power .phys {
		color: #FFFFFF;
		opacity: 1; }
		#gpio .overlay-power a {
		background: #073642;
		color: #FFFFFF; }
		#gpio .overlay-power a:hover {
		background: #268BD2; }
		#gpio .overlay-ground .phys {
		background: #073642;
		color: #FFFFFF;
		opacity: 1;
		position: absolute;
		top: 0px;
		width: 20px;
		height: 22px;
		border-radius: 11px;
		text-indent: 0px;
		line-height: 22px; }
		#gpio .overlay-ground a:hover .phys {
		background: #268BD2; }
		#gpio .overlay-ground span.pin {
		background: #073642; }
		#gpio ul li.hover-pin a,
		#gpio .bottom li.hover-pin a {
		color: #FFF;
		background: rgba(200, 0, 0, 0.6); }
		#gpio ul li.hover-pin a .phys,
		#gpio .bottom li.hover-pin a .phys {
		color: #FFF; }
		#gpio .pin1 a:hover, #gpio .pin1.active a, #gpio .pin1 .pin {
		border-radius: 0; }
		#gpio .pow3v3 .pin {
		background: #B58900; }
		#gpio .pow5v .pin {
		background: #DC322F; }
		#gpio .gpio .pin {
		background: #859900; }
		#gpio .i2c .pin {
		background: #268BD2; }
		#gpio .spi .pin {
		background: #D33682; }
		#gpio .pcm .pin {
		background: #2aa198; }
		#gpio .uart .pin {
		background: #6c71c4; }

		#legend h2 {
		margin-top: 5px;
		margin-bottom: 5px; }
		#legend div {
		width: 300px;
		float: left;
		display: block; }
		#legend img {
		width: 196px;
		height: auto;
		margin-top: 4px;
		float: left;
		display: block; }
		#legend p {
		font-size: 0.84em;
		padding: 0 10px 10px 0; }
		#legend ul, #legend li {
		list-style: none;
		margin: 0;
		padding: 0; }
		#legend li {
		position: relative;
		margin-bottom: 2px;
		line-height: 20px; }
		#legend li small {
		font-size: 0.7em; }
		#legend a {
		padding: 0 12px 0 30px; }
		#legend li, #legend a {
		color: #063541; }
		#legend .pow3v3 .pin {
		background: #B58900; }
		#legend .pow5v .pin {
		background: #DC322F; }
		#legend .gpio .pin {
		background: #859900; }
		#legend .i2c .pin {
		background: #268BD2; }
		#legend .spi .pin {
		background: #D33682; }
		#legend .uart .pin {
		background: #6c71c4; }
		#legend .pcm .pin {
		background: #2aa198; }
		#legend .pin {
		display: block;
		border: 1px solid transparent;
		border-radius: 50%;
		width: 16px;
		height: 16px;
		background: #002B36;
		position: absolute;
		left: 2px;
		top: 2px; }
		#legend .pin:after {
		content: '';
		display: block;
		border-radius: 100%;
		background: #FDF6E3;
		position: absolute;
		left: 5px;
		top: 5px;
		width: 6px;
		height: 6px; }


		@media (min-width: 1200px) {
		#container {
		width: 1200px; }

		.board {
		right: 1200px; }

		#content {
		width: 700px; }

		.boards-page #content {
		width: 898px; } }