View source for Products/PiSerialPower

{{DISPLAYTITLE:"PiSerialPower" Hat}}
Raspberry Pi 4 Hat with 5-28VDC - 3A power with barrel jack input, Fan, RTC with Supercap backup, Debug UART, temp sensor and WS2812 RGB led

[[Image:PiserialPower.jpg|300px|right]]

== Description ==
The "PiSerialPower" Hat Power-supply Hat for RaspberryPi (and pin-compatible competitors) which also provides a rich set of features :
* 5 to 28VDC barrel jack power input
* 5V - 3A voltage regulator to power the Raspberry Pi
* a Fan (PWM controlled)
* an RTC (PCF85363) with Super capacitor backup (about one month date/time retention, and will not need to be changed in a few years !)
* a USB to UART FTDI chip (FT230XS) to give you access to the debug console using a simple, common micro-USB cable
* a reset button
* a TMP101 temperature sensor
* and a WS2812 RGB led ... well, there was some place left on the PCB ...

The serial and reset signals are also available on a 2.54mm header.

Of course, the board uses the format specified by Raspberry Pi and allows access to both FPC connectors, and is provided with mounting screws.

The board comes fully assembled and tested.

== Where to buy ==
* [https://www.tindie.com/products/nathael/pi4-serial-and-power-board/ On Tindie]
* Directly from us using [http://paypal.me/TechnoInnov Paypal].
: Contact us by email before (sales *at* techno-innov.fr) to get a quotation which will include shipping costs and reduction for direct order.

== License ==
* Documentation : [https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode Creative Commons CC BY-SA-NC 4.0]
* Hardware : The PiSerialPower RPi Hat hardware and schematics are under [https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode Creative Commons CC BY-SA-NC 4.0] License. You can produce your own original or modified version of the PiSerialPower RPi Hat, and use it however you like, but not sell them, even without profit.
* Software : All the software examples created by Techno-Innov for the PiSerialPower RPi Hat are under GPLv3 License.
: Note that most of the software you will use with this Hat has not been written by us and is covered by other licenses. Refer to each software for more information.

== Hardware (Mechanical) ==
=== Dimensions ===
<gallery>
Image:Cotes.png|Fig 1 - Mechanical
Image:Cotes_Conn.png|Fig 2 - Connectors
Image:Cotes_Fan.png|Fig 3 - Fan
</gallery>
Figures 1, 2 and 3 give the different dimensions and the position of the main elements (FAN, connectors, reset button and user led) of the PiSerialPower RPi Hat.

== Connectors ==
[[Image:Connectors.png|Fig 4 - Connectors|360px|right]]
The HAT has one USB connector numbered P1, a DC barel Jack connector numbered P3, and two 2.54mm pitch headers numbered P4 (Debug) and P5 (Raspberry Pi connector). Refer to figure 4 for connectors position.<br />
Detailed description of the signals found on each connector pin follow.
* P1 : USB microB female connector.
* P3 : DC barrel jack. +Vin and ground input.
* P4 : 4 pins, 2.54mm pitch header. Provides Debug UART and Reset.
* P5 : 40 pins, 2.54mm pitch header. Provides access to RPI expansion header.

=== P1 : USB debug connector ===
P1 is a female USB microB port.<br />
Refer to the [http://fr.wikipedia.org/wiki/Universal_Serial_Bus Universal Serial Bus (USB)] page on Wikipedia for pinout and more information on the USB bus and connectors.

=== P3 : 2.1mm barrel jack ===
[[Image:P3.png|300px|right]]
P3 connector is a standard 2.1mm barrel jack.<br />
+Vin is on the central tip, and GND on the outer sleeve.<br />
Insersion detection is not used.<br />
P3 connector provides access to +Vin and Ground for the onboard step-down regulator. Despite the comment on the schematics, the input ranges from 5V to 24V (28V is the max allowed, and 30V the absolute max the step-down converter can handle) . This lets you power the board using a large variety of power sources.

'''Note''' : be very carefull when powering the board with a 24V power-supply, as the voltage can go well above 30V upon power-supply startup and destroy the step-down converter.<br />
Future versions will include a 28V zener diode between Vin and GND to further protect the Hat.

{| class="wikitable"
!colspan="4"|P3 connector
|-
| Pin #
| Description
| RPi signal
| RPi Pin
|-
|1
| +Vin : External unregulated input, +5V to +28V
| --
| --
|-
|2
|GND : Ground
|GND
|GND pins 6, 9, 14, 20, 25, 30, 34 and 39
|}

=== P4 Connector ===
[[Image:P4.png|300px|right]]
P4 connector is a standard 2.54mm (0.1 inch) pitch header, with 1 row of 4 pins.\\
P4 connector provides access to Debug UART and Reset.

{| class="wikitable"
!colspan="4"|P4 connector
|-
| Pin #
| Description
| RPi signal
| RPi Pin
|-
|1
|GND : Ground
|GND
|GND pins 6, 9, 14, 20, 25, 30, 34 and 39
|-
|2
|RPi TxD
|UART0 Tx
|pin 8
|-
|3
|RPi RxD
|UART0 Rx
|pin 10
|-
|4
|5V enable (Reset)
| --
| --
|}

'''Note''' : P4 connector allows direct access to the debug UART and to the power enable pin without powering
the USB-to-UART bridge. This option has been added to allow external access and control of clusters of
Raspberry Pi boards through a single UART concentrator with aditionnal GPIO to control the DC/DC enable
pin.

=== P5 Connector ===
[[Image:P5.png|300px|right]]
P5 connector is a standard 2.54mm (0.1 inch) pitch header, with 2 row of 20 pins.\\
P5 connector provides access to the Raspberry PI expansion header.

{| class="wikitable"
!colspan="3"|P5 connector
|-
| Pin #
| Description
| RPi signal
|-
|1
| +3.3V from RPi
| +3.3V
|-
|2
| +5V to RPi
| +5V
|-
|3
|SDA : Bidirectional Serial Data for I²C bus 1
|I2C1 SDA
|-
|4
| +5V to RPi
| +5V
|-
|5
|SCL : Clock for I²C bus 1
|I2C1 SCL
|-
|6
|GND : Ground
|GND
|-
|7
|RTC GPIO
|GPIO 4
|-
|8
|RPi TxD
|UART0 Tx
|-
|9
|GND : Ground
|GND
|-
|10
|RPi RxD
|UART0 Rx
|-
|11
|Temp sensor GPIO
|GPIO 17
|-
|12
|RGB Led
|GPIO 18 - PWM0
|-
|13
| --
| --
|-
|14
|GND : Ground
|GND
|-
|15
| --
| --
|-
|16
| --
| --
|-
|17
| +3.3V from RPi
| +3.3V
|-
|18
| --
| --
|-
|19
| --
| --
|-
|20
|GND : Ground
|GND
|-
|21
| --
| --
|-
|22
| --
| --
|-
|23
| --
| --
|-
|24
| --
| --
|-
|25
|GND : Ground
|GND
|-
|26
| --
| --
|-
|27
|SDA : Bidirectional Serial Data for I²C bus 0 (EEPROM)
|I2C0 SDA
|-
|28
|SCL : Clock for I²C bus 0 (EEPROM)
|I2C0 SCL
|-
|29
| --
| --
|-
|30
|GND : Ground
|GND
|-
|31
| --
| --
|-
|32
| --
| --
|-
|33
|Fan PWM
|GPIO 13 - PWM1
|-
|34
|GND : Ground
|GND
|-
|35
| --
| --
|-
|36
| --
| --
|-
|37
| --
| --
|-
|38
| --
| --
|-
|39
|GND : Ground
|GND
|-
|40
| --
| --
|}

== Electronic components ==
[[Image:Composants.png|360px|right]]
The PiSerialPower RPi Hat has been created using [http://www.kicad-pcb.org/display/KICAD/ KiCad EDA software] suite for the creation of the schematics and printed circuit boards.

See below for the full schematics. The sources for the schematics are available for download [http://techdata.techno-innov.fr/Adapters/PiSerialPower/PiSerialPower_Schematics.tar.bz2 here].

=== HAT Main Components Description ===
* U1 : TI TPS54302 DC-DC step-down converter.
* U2 : FTDI FT230XS USB to UART bridge.
* U5 : NXP PCF85363 RTC Clock.
* U6 : TI TMP101 I²C temperature sensor.
* U7 : ST M24C64 8KB EEPROM
* U8 : WS2812B user RGB led.
* D1 : Input power Presence.
* D2 : Green led : FTDI Rx activity.
* D3 : Orange led : FTDI Tx activity.
* D4 : USB FTDI Power OK.
* D5 : +3.3V Power from RPi.
* D6 : +5V to RPi.
* D7 : +5V from RPi.
* SW1 : Reset button.
* J1 : EEPROM write protection jumper (remove for write protection)

=== USB to UART bridge ===
[[Image:Prog.png|360px|right]]
In order to ease the development process on Raspberry Pi the HAT provides an USB to UART bridge.<br />
This bridge is made by a FTDI FT230XS chip, which is well supported on most operating systems so there is usually no configuration required to use it as a serial line on the host development system.
It provides a 3.3V regulated voltage for the UART interface but does not power the HAT or the Raspberry Pi.

The FTDI chip controls two "activity" leds for Rx (D2, the green one) and Tx (D3, orange one) data over the serial link.

The USB to UART bridge is connected to UART0 (pins 8 and 10) on the RPi connector. On most variants of  the RPi boards this interface must be activated manually in the device tree or in the bootloader configuration on the first partition of the SD card. Refer to the Raspberry Pi User Manual and online documentation and other ressources for more information on how to activate this interface.

=== I²C ===
The PiSerialPower RPi Hat uses both I²C busses from the RPi connector.<br />
Bus 0 holds the required EEPROM for HAT identification and configuration, at address 0x50.<br />
Bus 1 holds the TMP101 temperature sensor at address 0x4A and the PCF85363 RTC clock at address 0x51.

The following table shows all the possible I²C Addresses for the I²C components used on the HAT.

{| class="wikitable"
!colspan="3"|I²C Addresses
|-
| I²C Component
| 7 bits I²C address
| I²C Address + R / W bit
|-
|TMP101 Temperature sensor
|0x4A
|0x94 / 0x95
|-
|PCF85363 RTC Clock
|0x51
|0xA2 / 0xA3
|-
|24C64 EEPROM
|0x50
|0xA0 / 0xA1
|}

==== RTC Clock ====
[[Image:RTC.png|360px|right]]
The HAT includes a PCF85363 RTC with super-capacitor power backup.<br />
The use of a Super-capacitor for power backup lowers the environmental footprint and remove the need to replace (and dispose of) the battery at the expense of a shorter time retention, which is between one and two months, but should be enough for most applications.

The Linux kernel has support for the PCF85363 RTC in the rtc-pcf85363 module.<br />
After loading the rtc-pcf85363 module in the kernel, you must add the RTC to the list of devices on the I²C bus 1 :
 echo pcf85363 0x51 > /sys/bus/i2c/devices/i2c-1/new_device
This is not necessary if the device tree is loaded from the EEPROM.<br />
You can the access the RTC from <code>/dev/rtc0</code> or with the <code>hwclock</code> command (from the <code>util-linux</code> package on Debian based GNU/Linux distributions.


==== Temperature sensor ====
[[Image:TMP101.png|360px|right]]
The HAT has a TMP101 temperature sensor (from Texas Instrument) on the I²C bus 1 (address 0x94 / 0x95).

This temperature sensor has an "alert" function available through a dedicated pin. This pin is routed to pin 11 of the RPI connector (GPIO0_17) which allows the temperature sensor to send an event to the Raspberry Pi.<br />
Refer to the Raspberry Pi User Manual for more information on how to use this signal, and to the TMP101 documentation for more information on the temperature alert signal.

The Linux kernel has support for the TMP101 temperature sensor in the lm75 module.<br />
Once the lm75 module is loaded in the kernel, you must add the TMP101 sensor to the list of devices on the I²C bus 1 :<br />
 echo tmp101 0x4a > /sys/bus/i2c/devices/i2c-1/new_device
This is not necessary if the device tree is loaded from the EEPROM.<br />
You can then read the temperature using the <code>sensors</code> command, which is provided by the <code>lm-sensors</code> package on Debian based GNU/Linux distributions.


==== EEPROM ====
[[Image:EEPROM.png|360px|right]]
In order to respect the Pi HAT design requirements the HAT has a 24C64 (8Kbyte) EEPROM on I²C bus 0 at I²C address 0x50 (7bits).<br />
This EEPROM holds identification data and the HAT device tree blob which is loaded by the Linux kernel to enable the components (RTC and temperature sensor) found on the HAT.<br />
The EEPROM has a write protection pin which must be left floating or driven low to allow write operation. The control of the state of this write protection pin is made by the J1 jumper. When the jumper is present, the pin is driven low and the user can write to the EEPROM.<br />
Removing the jumper disables write operations.


=== Reset Button ===
[[Image:Reset.png|360px|right]]
The module has a reset button, connected directly to the enable pin of the step down regulator.<br />
Pressing the button removes power from this power source, which will immediately shut down the Raspberry Pi if it has no other power source, or do nothing if the RPi is also powered from its type C USB connector or any other way.

=== FAN ===
[[Image:Fan.png|360px|right]]
The module has a 25mm cooling FAN controlled by pin 33 of the RPI connector (GPIO_13 - PWM1).<br />
This pin is PWM capable, which allows you to control the FAN speed, though the fan used has an internal controller which prevents direct control using PWM, so we added a simple charge pump to modulate the fan voltage, which has the effect of modifing the FAN speed.

Refer to the Raspberry Pi User Manual and online documentation and other resources for more information on how to control the PWM output.


=== User RGB Led ===
[[Image:RGBLed.png|360px|right]]
The module has one WS2812B RGB Led connected to pin 12 of the RPI connector (GPIO_18 - PWM0). This Led is available for the user.<br />
Refer to the Raspberry Pi User Manual and online documentation and other resources for more information on how to control this WS2812B RGB Led.

== Software ==
=== Official and custom images ===
* [https://blog.cloudkernels.net/posts/rpi4-64bit-image/ Build a 64bit bootable image for a Raspberry Pi 4] (CloudKernels)
* [https://wiki.debian.org/RaspberryPi Raspberry Pi information on Debian wiki]
* [https://www.raspberrypi.org/downloads/ Raspberry Pi official images download] and [https://www.raspberrypi.org/documentation/installation/installing-images/README.md installation instructions]

=== I2C : RTC, EEPROM and temperature sensor support ===
Kernel Modules (use modprobe to load them if they are not already loaded or included in the main kernel image) :
* RTC : rtc-pcf85363.ko
* TMP101 : lm75.ko
* EEPROM : at24.ko

Check that the components are detected :
* root@raspberrypi:~# i2cdetect 1
: [...]
: 40: -- -- -- -- -- -- -- -- -- -- 4a -- -- -- -- -- 
: 50: -- 51 -- -- -- -- -- -- -- -- -- -- -- -- -- -- 
: [...]
* root@raspberrypi:~# i2cdetect 0
: [...]
: 50: 50 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 
: [...]

* echo tmp101 0x4a > /sys/bus/i2c/devices/i2c-1/new_device
* echo 24c64 0x50 > /sys/bus/i2c/devices/i2c-0/new_device
* echo pcf85363 0x51 > /sys/bus/i2c/devices/i2c-1/new_device

=== GPIO ===
GPIO support with Raspberry-Pi is a real pain.<br />
Obviously, people do not understand what "stable" means, and try to create new interfaces for GPIO both from the kernel and from the userspace, each supposed to be the very best one, but none usable, making about every piece of information obsolete.

==== PWM Support for FAN control ====
* Device tree information :
: https://github.com/raspberrypi/linux/blob/rpi-4.19.y/arch/arm/boot/dts/overlays/pwm-overlay.dts
: https://www.raspberrypi.org/forums/viewtopic.php?t=222428

* Solution using pigpio (pigpiod daemon) and pigs for hardware PWM
 pigpiod
 pigs hp 13 100000 0
 pigs hp 13 100000 30000
 pigs hp 13 100000 1000000
 killall pigpiod
Remember to kill pigpiod or it will burn your processor to death. PWM keeps running after pigpiod is killed.

=== WS2812B Support ===
The WS2812B is connected to pin 12 of the Raspberry Pi connector, which is gpio 18 - PWM0 <br />
I gathered various information, I hope it will be usefull :
* https://pinout.xyz/pinout/pin12_gpio18#
* https://github.com/pimoroni/unicorn-hat
* https://github.com/richardghirst/rpi_ws281x et https://github.com/jgarff/rpi_ws281x

=== dtb generation and eeprom flash ===
DTB sources :
* [https://github.com/raspberrypi/linux/tree/rpi-4.19.y/arch/arm/boot/dts/overlays List of overlays] on Raspberry Pi's official git repository
* Our [http://techdata.techno-innov.fr/Adapters/PiSerialPower/overlay.dts overlay.dts]

You will also need eepromutils to flash the EEPROM : 
* [https://github.com/raspberrypi/hats/tree/master/eepromutils eepromutils from Raspberry Pi's official git repository]
* Our [http://techdata.techno-innov.fr/Adapters/PiSerialPower/eeprom_settings.txt eeprom_settings.txt]

Generate the dtbo and flash the EEPROM ('''Note''' : the write protection jumper must be "on" in order to flash the EEPROM) :
 dtc -@ -I dts -O dtb -o overlay.dtbo overlay.dts
 dtoverlay overlay.dtbo
 ./eepmake eeprom_settings.txt myhat.eep overlay.dtbo
 ./eepflash.sh -w -f=myhat.eep -t=24c64 -a=50 -d=0

You can erase the EEPROM with the following command (blank.eep is an 8Kb file filled with zeroes) :
 ./eepflash.sh -w -f=blank.eep -t=24c64 -a=50 -d=0

== Links to various Raspberry Pi information ==
=== Raspberry Pi 4 specs ===
* https://www.raspberrypi.org/products/raspberry-pi-4-model-b/specifications/

=== Hats mechanical data ===
* https://github.com/raspberrypi/hats/blob/master/designguide.md
* [https://github.com/raspberrypi/hats/blob/master/hat-board-mechanical.pdf hat-board-mechanical.pdf]
* https://www.raspberrypi.org/blog/introducing-raspberry-pi-hats/

=== EEPROM ID ===
* https://www.raspberrypi.org/forums/viewtopic.php?t=108134

=== Raspberry Pi Pinouts ===
* https://pinout.xyz/pinout/

== TODO List ==
* Test over-voltage protection with 28V zener diode and/or add resetable fuse on power input
* Manage to sell a few (or many) boards ! Orders welcome !

== Schematics, sources and PDF of documentation ==
* Current documentation (PDF subpart of what's on this page) [http://techdata.techno-innov.fr/Adapters/PiSerialPower/PiSerialPower.pdf here]
* Sources for the schematics [http://techdata.techno-innov.fr/Adapters/PiSerialPower/PiSerialPower_Schematics.tar.bz2 here]

== History ==
=== v0.1 ===
This board revision has not been sold to public. First prototype version, produced on customer request.
=== v0.2 ===
Actual version sold as of writting of this documentation. Fixes v01 mistakes and adds PWM for the FAN and a RGB led.