powerfeather/powerfeather-sdk

1.0.5

uploaded 2 weeks ago
Software development kit for PowerFeather boards

readme

# PowerFeather-SDK

The following boards are supported:

| Board                 | Arduino Support | ESP-IDF Support   |
|-----------------------|-----------------|-------------------|
| ESP32-S3 PowerFeather | Yes             | Yes               |

## Setup

Setup for supported platforms is documented on [docs.powerfeather.dev/sdk/setup](https://docs.powerfeather.dev/sdk/setup).

## Examples

### Arduino

- [EnterShipMode](https://github.com/PowerFeather/powerfeather-sdk/tree/main/examples/EnterShipMode) - Demonstrates how to enter ship mode for Arduino.
- [SupplyAndBatteryInfo](https://github.com/PowerFeather/powerfeather-sdk/tree/main/examples/SupplyAndBatteryInfo) - Demonstrates how to retrieve basic information about the external supply and battery for Arduino.

### ESP-IDF

- [enter_ship_mode](https://github.com/PowerFeather/powerfeather-sdk/tree/main/examples/enter_ship_mode) - Demonstrates how to enter ship mode for ESP-IDF.
- [supply_and_battery_info](https://github.com/PowerFeather/powerfeather-sdk/tree/main/examples/supply_and_battery_info) - Demonstrates how to retrieve basic information about the external supply and battery for ESP-IDF.


## Links

- [Discussions](https://forum.powerfeather.dev/t/firmware-sdk)
- [Issue Tracker](https://github.com/PowerFeather/powerfeather-sdk/issues)
- [Repository](https://github.com/PowerFeather/powerfeather-sdk.git)
- [Documentation](https://docs.powerfeather.dev/category/sdk)

Links

Supports all targets

License: PowerFeather 4-Clause License

To add this component to your project, run:

idf.py add-dependency "powerfeather/powerfeather-sdk^1.0.5"

or download archive

Dependencies

  • ESP-IDF >=4.4

    • Examples:

    enter_ship_mode

    To create a project from this example, run:

    idf.py create-project-from-example "powerfeather/powerfeather-sdk^1.0.5:enter_ship_mode"

    or download archive (58 bytes)

    supply_and_battery_info

    To create a project from this example, run:

    idf.py create-project-from-example "powerfeather/powerfeather-sdk^1.0.5:supply_and_battery_info"

    or download archive (58 bytes)

    Stats

    • Archive size
      Archive size: 23.33 KB
    • Downloaded in total
      Downloaded in total 9 times
    • Downloaded this version
      This version: 0 times

    Badge

    powerfeather/powerfeather-sdk version: 1.0.5
    |
    report abuse