Code Monkey home page Code Monkey logo

esp-pacs's Introduction

esp-pacs

GitHub Workflow Status MIT/Apache-2.0 licensed Matrix

Peripheral Access Crates for Espressif SoCs and modules. For information on how to use these crates, please refer to the svd2rust documentation.

If you discover any errors in an SVD file, please report the issue(s) upstream in the espressif/svd repository.

Please note that in order to build the PACs for Xtensa devices (ESP32, ESP32-S2, ESP32-S3, ESP8266) you will need to first install the Rust compiler fork with Xtensa support. The minimum supported Rust version (MSRV) for these devices is 1.58.0.

Generating the PACs

We use the workflow described by cargo-xtask to automate tasks within this monorepo. Currently there is only a single task, which generates a Peripheral Access Crate (PAC) for the specified chip.

xtask

USAGE:
    xtask [OPTIONS] <CHIP>

ARGS:
    <CHIP>    Chip to target [possible values: esp32, esp32c3, esp32s2, esp32s3, esp8266]

OPTIONS:
        --generate-only    Patch the SVD and generate the PAC, but do not build it
    -h, --help             Print help information
        --patch-only       Only patch the SVD, do not generate or build the PAC

For example, to generate a PAC for the ESP32-C3 without subsequently building the crate, from the root of the repository run:

$ cargo xtask --generate-only esp32c3

License

Licensed under either of:

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

esp-pacs's People

Contributors

bjoernq avatar jessebraham avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.