SparkFun Ambiq Apollo3 Arduino Core

An mbed-os enabled Arduino core for Ambiq Apollo3 based boards

Contents

• SparkFun Ambiq Apollo3 Arduino Core
  • Contents
  • Installation
    • Arduino Boards Manager (recommended)
    • Git (development)
  • Getting Started
  • Development Status
    • Priorities
  • More
    • License
    • Contributing
    • Issue Template
    • Acknowledgements

Installation

Arduino Boards Manager (recommended)

• Copy / paste the JSON package URL into the 'Additional Boards Manager URLs' field in Arduino preferences https://raw.githubusercontent.com/sparkfun/Arduino_Apollo3/main/package_sparkfun_apollo3_index.json https://raw.githubusercontent.com/sparkfun/Arduino_Apollo3/main/package_sparkfun_apollo3_index.json
• Open 'Boards Manager' and select 'SparkFun Apollo3 Boards' - install the latest version

Git (development)

• Ensure the proper directory structure exists by following the Arduino Boards Manager instructions (install latest)
• navigate to your directory with the latest version
• rename the directory from 2.x.x to .bckup2.x.x (or simply delete it and download it later if wanted)
• clone this repo git clone https://github.com/sparkfun/Arduino_Apollo3.git
• checkout desired branch cd Arduino_Apollo3 git checkout release-candidate
• update all submodules git submodule update --init --recursive
• rename directory from Arduino_Apollo3 to 2.x.x from above
• restart Arduino and enjoy.

Getting Started

For in depth tutorials, checkout out the Artemis page for the latest. Tutorials that may be of interest include:

• Installing Board Definitions in the Arduino IDE
• Artemis Development with the Arduino IDE

If you are comfortable with the arduino IDE and already have the boards installed, we recommend trying some examples from within the arduino IDE. Start with the "Built-in Examples" from arduino, but don't forget to checkout out some of the board specific examples that we have included with the package. These demonstrate how to use some of the libraries that make our Artemis board unique, and can take your next project to a new level!

Development Status

• v2.0.0 Based on an mbed-os framework
• v2.1.0 Contains latest fixes for the v2 core and feature that have been added since v2 release

For more information on how to contribute or how to navigate this repo, check out the Contributing page.

As mentioned MbedOS is the framework to our latest Arduino Core. To contribute to, or use these targets on, MbedOS check out the main repo by ARM. This library uses mbed libraries built from a fork of mbed that is maintained by us. The latest version of that repo can be found here.

Main Arduino Features

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

Standard Libraries

• Wire
  • Controller: ✅
  • Peripheral: 🤔
• SPI
  • Controller: ✅
  • Peripheral: 🤔
• EEPROM: ✅

Apollo3 Specialty Peripherals

• PDM Microphones / I2S: ✅
• BLE: ✅
• RTC: ✅
• Watchdog Timer: ✅
• Burst Mode: ✅

More

License

Contributing

Issue Template

Acknowledgements