jcbrtl/Arduino_Apollo3

Arduino core to support the Apollo3 microcontroller from Ambiq Micro

Arduino Core for Apollo3 Microcontroller

Contents

• Installation
• Development Status
• Issue Template
• Repo Contents
• Acknowledgements

Installation

• Using Arduino IDE Boards Manager (Reccomended)
  • Follow the instructions at the SparkFun Arduino Boards Repo
  • Open 'Boards Manager' and select 'SparkFun Apollo3 Boards,' install the latest version.
  • JSON boards manager link for convenience: https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json

Development Status

The basic necesseties are in-place. This means that you can compile and upload code to your Apollo3 board. Development can be done with the whole range of Hardware Abstraction Layer functions provided in the AmbiqSuite Software Development Kit (based on Release2.1.0).

Main Arduino Features

• Serial: ✅
• GPIO: ✅
• Analog / Servo Output: ✅
• Analog Input: ✅
• Timing / Delays: ✅

Standard Libraries

• Wire
  • Master: ✅
  • Slave: ❌
• SPI
  • Master: ✅
  • Slave: ❌
• Software Serial: ✅

Apollo3 Specialty Peripherals

• PDM Microphones / I2S: ✅
• BLE: 🤔
• Multi-bit SPI: 🤔
• I2C/SPI Slave: 🤔

How to Contribute

The goal of this Arduino Core is to provide excellent Apollo3 support in a clear and extendable manner. The guidelines for contributing and submitting issues are designed to make it easy to integrate work from many people.

• Issue Template

  • Please do a thorough search of all issues before posting your own. When you're sure that your issue has not been covered please use the Issue Template to guide your report. Even better, if your issue is a feature request or a fix that you know how to implement please consider contributing with a Pull Request.

• Contributor's Guidelines

  • Please read and follow the Contributor's Guidelines when making commits for a Pull Request.

• Acknowledgements

  • The Acknowledgments file exists to easily recognize contributors by name. Detailed contribution information will be recorded by the git commit history.

Repo Contents

• bootloaders: source code and binary images of the SparkFun Variable Loader (SVL)
• cores : source code and headers common to all Apollo3 Arduino boards
• docs :
  • CONTRIBUTING.md
  • ISSUE_TEMPLATE.md
  • LICENSE.md
• libraries : common source code for optional libraries that pertain to Apollo3 HW
• tools : peripherals such as the serial uploader
• variants : pin mapping and capability listing for individual boards