Giter VIP home page Giter VIP logo

jcbrtl / ambiqsuitesdk Goto Github PK

View Code? Open in Web Editor NEW

This project forked from sparkfun/ambiqsuitesdk

0.0 1.0 0.0 173.19 MB

A copy of the AmbiqSuite SDK available on GitHub. Can be used to include AmbiqSuite as a submodule. May be used to track issues in SDK releases, however this repo is not maintained by AmbiqMicro

C 84.03% Assembly 6.95% Makefile 7.69% Objective-C 0.01% C++ 0.54% Python 0.78% Batchfile 0.01%

ambiqsuitesdk's Introduction

AmbiqSuiteSDK

A copy of the AmbiqSuite SDK available on GitHub. Can be used to include AmbiqSuite as a submodule. Can be used to track issues with the SDK, however it is not maintained by AmbiqMicro so the issues may not be resolved upstream.

Current Version

2.4.2

Getting Started

First make sure that the necessary tools are available at your command line. They are:

  • Git
    • git
  • Make
    • make
  • ARM GCC
    • arm-none-eabi-xxx (preferably 8-2018-q4-major - there is a known problem with 8-2019-q3-update for example)
  • Python3
    • python3

Then follow these steps

git clone --recursive https://github.com/sparkfun/AmbiqSuiteSDK
cd AmbiqSuiteSDK
cd boards_sfe/common/examples/{example}/gcc
YOUR_BOARD=redboard_artemis_atp   # choose the bsp directory name of the board you want to use
make BOARD=$YOUR_BOARD            # build project
make BOARD=$YOUR_BOARD bootload         # equivalent to 'bootload_svl'
make BOARD=$YOUR_BOARD bootload_svl     # bootloads using the SparkFun Variable Loader
make BOARD=$YOUR_BOARD bootload_asb     # bootloads using the Ambiq Secure Bootloader - overwrites SparkFun Variable Loader

Advanced Usage

All the convenient functionality that we've added to the AmbiqSuiteSDK comes from our SparkFun AmbiqSuite Apollo3 BSPs. That repo contains more detailed documentation for advanced usage.

Repository Structure

In addition to including the SparkFun BSPsThis repo catalogs information about the AmbiqSuite SDK. Various branches serve different purposes:

Branch Purposes

Pattern Use Addtl. info
master contains the most up-to-date version of the SDK along with all patches
mirror mirrors latest SDK available from AmbiqMicro
*-archive provides an archive of the SDK as released by AmbiqMicro at each version
*-patch-*description provides a version of the SDK patched beyond AmbiqMicro release

Submodules

Git submodules can be used to reuse code between repositories. Some special precautions can be necessary when working with them -- most notably the need to clone the contents of submodules explicitly. Here's how to do that:

  • If you've already cloned a repo
    • git submodule update --init --recursive
  • If you are about to clone the repo
    • git clone --recursive <project url>

Maintainers of this repo may also need to keep submodules updated.

Here are some more documents about submodules.

This repo includes the following git submodules:

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.