Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manuelbl/usb-pd-arduino
USB Power Delivery for Arduino
https://github.com/manuelbl/usb-pd-arduino
arduino arduino-library platformio usb usb-pd
Last synced: about 1 month ago
JSON representation
USB Power Delivery for Arduino
- Host: GitHub
- URL: https://github.com/manuelbl/usb-pd-arduino
- Owner: manuelbl
- License: mit
- Created: 2023-04-24T21:23:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-30T21:43:08.000Z (8 months ago)
- Last Synced: 2024-04-30T22:39:40.232Z (8 months ago)
- Topics: arduino, arduino-library, platformio, usb, usb-pd
- Language: C++
- Homepage:
- Size: 218 KB
- Stars: 39
- Watchers: 2
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# USB Power Delivery for Arduino
Implement a USB PD protocol analyzer, a USB PD trigger board or a more sophisticated power sink using a few additional components and simple Arduino code. Supports several STM32 microcontrollers.
Depending on the microcontroller, a comparator and a few resistors are needed, or just the resistors or no additional component at all. See below for more details. For 5 USD in parts, you can build a USB PD protocol analyzer.
## Supported Boards
| Board | Required additional components |
| - | - |
| Blue Pill (STM32F103C8) | Dual comparator, several resistors |
| Black Pill (STM32F401CC) | Dual comparator, several resistors |
| Nucleo-L432KC | Several resistors (for power sink) or none (for protocol analyzer) |
| Nucleo-G071RB | None |
| Nucleo-G431KB | None |
| Nucleo-G474RE | None |
All boards require an additional USB C connector as the standard connector is not ready for USB Power Delivery (no USB C connector, CC1/CC2 signals not available, voltage regular cannot handle more than 5V).
For the Nucelo boards in Nucleo-64 form factor, the X-NUCLEO-SNK1M1 shield can be used.
See the Wiki for how to wire the board and the additional components.
## Library Installation (Arduino IDE)
1. In the Arduino IDE, navigate to *Sketch > Include Library > Manage Libraries...*
2. The Library Manager will open and you will find a list of libraries that are already installed or ready for installation.
3. Search for *Power Delivery* using the search bar.
4. Click on the *INSTALL* button to install it.
## Examples
### Protocol Analyzer
The protocol analyzer can be connected between two USB PD devices to monitor the USB PD communication.
```c++
#include "USBPowerDelivery.h"
void setup() {
Serial.begin(115200);
PowerController.startMonitor();
}
void loop() {
PDProtocolAnalyzer.poll();
}
```
See the Wiki for details regarding the required components and wiring.
### Trigger Board
The trigger boards communicates with a USB power supply and requests a different voltage than the initial 5V.
```c++
#include "USBPowerDelivery.h"
void setup() {
PowerSink.start();
// request 12V @ 1A once power supply is connected
PowerSink.requestPower(12000, 1000);
}
void loop() {
// nothing to do
}
```
See the Wiki for details regarding the required components and wiring.
## Restrictions
- This library uses several peripherals exclusively (e.g. one or two timers and the ADC in many cases). The peripheral can no longer be used by your own code as it would interfer with the operation of this library. Please read to restrictions that apply to your board.
- The USB PD protocol is very timing sensitive. In order to be robust even in the presence of blocking code (e.g. `Serial.println()`), most of the USB PD processing is done in interrupt handlers. While receiving a USB PD message, interrupt handlers can consume up to 40% of the CPU time.