From f980889b36b205b5367e4193cdc3dfd3c84aa923 Mon Sep 17 00:00:00 2001 From: Lucien RENAUD Date: Tue, 15 Nov 2022 14:07:36 +0100 Subject: [PATCH] Add Arduino Code to programm PD chip --- USB PD ST4500 Set voltage/.gitignore | 5 + USB PD ST4500 Set voltage/include/README | 39 ++++++++ USB PD ST4500 Set voltage/lib/README | 46 +++++++++ USB PD ST4500 Set voltage/platformio.ini | 20 ++++ USB PD ST4500 Set voltage/src/main.cpp | 116 +++++++++++++++++++++++ USB PD ST4500 Set voltage/test/README | 11 +++ 6 files changed, 237 insertions(+) create mode 100644 USB PD ST4500 Set voltage/.gitignore create mode 100644 USB PD ST4500 Set voltage/include/README create mode 100644 USB PD ST4500 Set voltage/lib/README create mode 100644 USB PD ST4500 Set voltage/platformio.ini create mode 100644 USB PD ST4500 Set voltage/src/main.cpp create mode 100644 USB PD ST4500 Set voltage/test/README diff --git a/USB PD ST4500 Set voltage/.gitignore b/USB PD ST4500 Set voltage/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/USB PD ST4500 Set voltage/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/USB PD ST4500 Set voltage/include/README b/USB PD ST4500 Set voltage/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/USB PD ST4500 Set voltage/include/README @@ -0,0 +1,39 @@ + +This directory is intended for project header files. + +A header file is a file containing C declarations and macro definitions +to be shared between several project source files. You request the use of a +header file in your project source file (C, C++, etc) located in `src` folder +by including it, with the C preprocessing directive `#include'. + +```src/main.c + +#include "header.h" + +int main (void) +{ + ... +} +``` + +Including a header file produces the same results as copying the header file +into each source file that needs it. Such copying would be time-consuming +and error-prone. With a header file, the related declarations appear +in only one place. If they need to be changed, they can be changed in one +place, and programs that include the header file will automatically use the +new version when next recompiled. The header file eliminates the labor of +finding and changing all the copies as well as the risk that a failure to +find one copy will result in inconsistencies within a program. + +In C, the usual convention is to give header files names that end with `.h'. +It is most portable to use only letters, digits, dashes, and underscores in +header file names, and at most one dot. + +Read more about using header files in official GCC documentation: + +* Include Syntax +* Include Operation +* Once-Only Headers +* Computed Includes + +https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html diff --git a/USB PD ST4500 Set voltage/lib/README b/USB PD ST4500 Set voltage/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/USB PD ST4500 Set voltage/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into executable file. + +The source code of each library should be placed in a an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +and a contents of `src/main.c`: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/USB PD ST4500 Set voltage/platformio.ini b/USB PD ST4500 Set voltage/platformio.ini new file mode 100644 index 0000000..11709e3 --- /dev/null +++ b/USB PD ST4500 Set voltage/platformio.ini @@ -0,0 +1,20 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:nucleo_f411re] +platform = ststm32 +board = nucleo_f411re +lib_archive = false +framework = arduino +lib_deps = + sparkfun/SparkFun STUSB4500@^1.1.5 + wire +monitor_port = COM5 +monitor_speed = 115200 \ No newline at end of file diff --git a/USB PD ST4500 Set voltage/src/main.cpp b/USB PD ST4500 Set voltage/src/main.cpp new file mode 100644 index 0000000..22127ac --- /dev/null +++ b/USB PD ST4500 Set voltage/src/main.cpp @@ -0,0 +1,116 @@ +#include + +#include +#include + +STUSB4500 usb; + +void setup() +{ + Serial.begin(115200); + Wire.begin(); //Join I2C bus + + delay(500); + + /* The Power Delivery board uses the default settings with address 0x28 using Wire. + + Opionally, if the address jumpers are modified, or using a different I2C bus, + these parameters can be changed here. E.g. usb.begin(0x29,Wire1) + + It will return true on success or false on failure to communicate. */ + if(!usb.begin()) + { + Serial.println("Cannot connect to STUSB4500."); + Serial.println("Is the board connected? Is the device ID correct?"); + while(1); + } + + Serial.println("Connected to STUSB4500!"); + delay(100); + + /* Read the Power Data Objects (PDO) highest priority (1-3) */ + Serial.print("PDO Number: "); + Serial.println(usb.getPdoNumber()); + + /* Read settings for PDO1 + - Voltage fixed at 5V + - Current value for PDO1 0-5A, if 0 used, FLEX_I value is used + - Under Voltage Lock Out fixed at 3.3V (but will always return 0) + - Over Voltage Lock Out 5-20% + */ + Serial.println(); + Serial.print("Voltage1 (V): "); + Serial.println(usb.getVoltage(1)); + Serial.print("Current1 (A): "); + Serial.println(usb.getCurrent(1)); + Serial.print("Lower Voltage Tolerance1 (%): "); + Serial.println(usb.getLowerVoltageLimit(1)); + Serial.print("Upper Voltage Tolerance1 (%): "); + Serial.println(usb.getUpperVoltageLimit(1)); + Serial.println(); + + /* Read settings for PDO2 + - Voltage 5-20V + - Current value for PDO2 0-5A, if 0 used, FLEX_I value is used + - Under Voltage Lock Out 5-20% + - Over Voltage Lock Out 5-20% + */ + Serial.print("Voltage2 (V): "); + Serial.println(usb.getVoltage(2)); + Serial.print("Current2 (A): "); + Serial.println(usb.getCurrent(2)); + Serial.print("Lower Voltage Tolerance2 (%): "); + Serial.println(usb.getLowerVoltageLimit(2)); + Serial.print("Upper Voltage Tolerance2 (%): "); + Serial.println(usb.getUpperVoltageLimit(2)); + Serial.println(); + + /* Read settings for PDO3 + - Voltage 5-20V + - Current value for PDO3 0-5A, if 0 used, FLEX_I value is used + - Under Voltage Lock Out 5-20% + - Over Voltage Lock Out 5-20% + */ + Serial.print("Voltage3 (V): "); + Serial.println(usb.getVoltage(3)); + Serial.print("Current3 (A): "); + Serial.println(usb.getCurrent(3)); + Serial.print("Lower Voltage Tolerance3 (%): "); + Serial.println(usb.getLowerVoltageLimit(3)); + Serial.print("Upper Voltage Tolerance3 (%): "); + Serial.println(usb.getUpperVoltageLimit(3)); + Serial.println(); + + /* Read the flex current value (FLEX_I) */ + Serial.print("Flex Current: "); + Serial.println(usb.getFlexCurrent()); + + /* Read the External Power capable bit */ + Serial.print("External Power: "); + Serial.println(usb.getExternalPower()); + + /* Read the USB Communication capable bit */ + Serial.print("USB Communication Capable: "); + Serial.println(usb.getUsbCommCapable()); + + /* Read the POWER_OK pins configuration */ + Serial.print("Configuration OK GPIO: "); + Serial.println(usb.getConfigOkGpio()); + + /* Read the GPIO pin configuration */ + Serial.print("GPIO Control: "); + Serial.println(usb.getGpioCtrl()); + + /* Read the bit that enables VBUS_EN_SNK pin only when power is greater than 5V */ + Serial.print("Enable Power Only Above 5V: "); + Serial.println(usb.getPowerAbove5vOnly()); + + /* Read bit that controls if the Source or Sink device's + operating current is used in the RDO message */ + Serial.print("Request Source Current: "); + Serial.println(usb.getReqSrcCurrent()); +} + +void loop() +{ +} \ No newline at end of file diff --git a/USB PD ST4500 Set voltage/test/README b/USB PD ST4500 Set voltage/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/USB PD ST4500 Set voltage/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner and project tests. + +Unit Testing is a software testing method by which individual units of +source code, sets of one or more MCU program modules together with associated +control data, usage procedures, and operating procedures, are tested to +determine whether they are fit for use. Unit testing finds problems early +in the development cycle. + +More information about PlatformIO Unit Testing: +- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html