Browse Source

README improvements

Clara Hobbs 6 years ago
parent
commit
40868227be
2 changed files with 21 additions and 8 deletions
  1. 16
    8
      README.md
  2. 5
    0
      lib/README.md

+ 16
- 8
README.md View File

1
 # PD Buddy Sink Firmware
1
 # PD Buddy Sink Firmware
2
 
2
 
3
-This is the firmware for the PD Buddy project.  Currently, this specifically
4
-means the [PD Buddy Sink][].  The firmware is considered stable, and supports
5
-the most common use cases for the device.
3
+This is the firmware for the [PD Buddy Sink][], a smart power jack for USB
4
+Power Delivery.
5
+
6
+The firmware is written using [ChibiOS][] RT and HAL, and is comprised of a
7
+[library][] for USB Power Delivery and an application using that library to
8
+request a configured voltage and current.
6
 
9
 
7
 [PD Buddy Sink]: https://git.clayhobbs.com/pd-buddy/pd-buddy-sink
10
 [PD Buddy Sink]: https://git.clayhobbs.com/pd-buddy/pd-buddy-sink
11
+[ChibiOS]: http://www.chibios.org/
12
+[library]: lib/README.md
8
 
13
 
9
 ## Features
14
 ## Features
10
 
15
 
26
 * The amount of current the device requests can be set as a power or a
31
 * The amount of current the device requests can be set as a power or a
27
   resistance, as well as a current.  These values are taken as constant over
32
   resistance, as well as a current.  These values are taken as constant over
28
   the configured voltage range.
33
   the configured voltage range.
29
-* Setup mode implements a USB CDC-ACM command-line interface allowing
30
-  configuration to be loaded from and stored in flash.
34
+* Setup mode implements a USB CDC-ACM command-line interface, compatible with
35
+  Linux, Mac OS X, and Windows 10, allowing configuration to be loaded from and
36
+  stored in flash.
31
 * Setup mode allows real-time renegotiation of voltage and current, complete
37
 * Setup mode allows real-time renegotiation of voltage and current, complete
32
   with the ability to control whether the output is enabled or disabled.
38
   with the ability to control whether the output is enabled or disabled.
33
-* User can easily read a power supply's advertised capabilities while in Setup
34
-  mode.
35
-* Firmware upgrades are easily possible via Setup mode and the
39
+* Users can easily read a power supply's advertised capabilities while in Setup
40
+  mode using a [PD Buddy Wye][].
41
+* Firmware upgrades are easily possible via Setup mode in conjunction with the
36
   microcontroller's built-in DfuSe bootloader.
42
   microcontroller's built-in DfuSe bootloader.
37
 
43
 
44
+[PD Buddy Wye]: https://git.clayhobbs.com/pd-buddy/pd-buddy-wye
45
+
38
 ## Prerequisites
46
 ## Prerequisites
39
 
47
 
40
 To compile the firmware, you must first install the [GNU ARM Embedded
48
 To compile the firmware, you must first install the [GNU ARM Embedded

+ 5
- 0
lib/README.md View File

4
 Revision 2.0, Version 1.3, and Revision 3.0, Version 1.1, for microcontrollers
4
 Revision 2.0, Version 1.3, and Revision 3.0, Version 1.1, for microcontrollers
5
 running [ChibiOS][] and connected to an [FUSB302B][] USB Power Delivery PHY.
5
 running [ChibiOS][] and connected to an [FUSB302B][] USB Power Delivery PHY.
6
 
6
 
7
+The library's API is not yet considered stable, and is not documented outside
8
+of source code comments.  For an example of its use, see the [PD Buddy Sink
9
+Firmware][].
10
+
7
 [ChibiOS]: http://www.chibios.org/
11
 [ChibiOS]: http://www.chibios.org/
8
 [FUSB302B]: http://www.onsemi.com/PowerSolutions/product.do?id=FUSB302B
12
 [FUSB302B]: http://www.onsemi.com/PowerSolutions/product.do?id=FUSB302B
13
+[PD Buddy Sink Firmware]: https://git.clayhobbs.com/pd-buddy/pd-buddy-firmware

Loading…
Cancel
Save