Skip to content

Commit eeedd44

Browse files
committed
Documentation update
1 parent a522571 commit eeedd44

File tree

6 files changed

+49
-226
lines changed

6 files changed

+49
-226
lines changed

README.MD

Lines changed: 6 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,10 @@
1-
![Generate Variants Status Badge](https://github.com/sparkfun/Arduino_Apollo3/workflows/Generate%20Variants/badge.svg)
1+
# Sapphire Circuits Ambiq Apollo3 Plus Arduino Core
22

3-
# SparkFun Ambiq Apollo3 Arduino Core
4-
An mbed-os enabled Arduino core for Ambiq Apollo3 based boards
5-
6-
## Contents
7-
- [SparkFun Ambiq Apollo3 Arduino Core](#sparkfun-ambiq-apollo3-arduino-core)
8-
- [Contents](#contents)
9-
- [Installation](#installation)
10-
- [**Arduino Boards Manager** (recommended)](#arduino-boards-manager-recommended)
11-
- [**Git** (development)](#git-development)
12-
- [Getting Started](#getting-started)
13-
- [Development Status](#development-status)
14-
- [Priorities](#priorities)
15-
- [More](#more)
16-
- [License](#license)
17-
- [Contributing](#contributing)
18-
- [Issue Template](#issue-template)
19-
- [Acknowledgements](#acknowledgements)
3+
Arduino core to support the Apollo3 Blue Plus microcontroller from Ambiq Micro. Hardware available through our Kickstarter: [https://www.kickstarter.com/projects/davewy/artemis-plus-low-power-ai-ml-processing-platform-and-dev-kit](https://www.kickstarter.com/projects/davewy/artemis-plus-low-power-ai-ml-processing-platform-and-dev-kit)
204

215
## Installation
22-
### **Arduino Boards Manager** (recommended)
6+
### **Arduino Boards Manager**
237
- Copy / paste the JSON package URL into the 'Additional Boards Manager URLs' field in Arduino preferences
24-
```https://raw.githubusercontent.com/sparkfun/Arduino_Apollo3/main/package_sparkfun_apollo3_index.json```
25-
[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)
26-
- Open 'Boards Manager' and select 'SparkFun Apollo3 Boards' - install the latest version
27-
28-
### **Git** (development)
29-
- Ensure the proper directory structure exists by following the [Arduino Boards Manager](#arduino-boards-manager) instructions (install latest)
30-
- navigate to your directory with the latest version
31-
- rename the directory from 2.x.x to .bckup2.x.x (or simply delete it and download it later if wanted)
32-
- clone this repo
33-
`git clone https://github.com/sparkfun/Arduino_Apollo3.git`
34-
- checkout desired branch
35-
`cd Arduino_Apollo3`
36-
`git checkout release-candidate`
37-
- update all submodules
38-
`git submodule update --init --recursive`
39-
- rename directory from Arduino_Apollo3 to 2.x.x from above
40-
- restart Arduino and enjoy.
41-
42-
## Getting Started
43-
For in depth tutorials, checkout out the [Artemis page](https://www.sparkfun.com/artemis) for the latest. Tutorials that may be of interest include:
44-
- [Installing Board Definitions in the Arduino IDE](https://learn.sparkfun.com/tutorials/installing-board-definitions-in-the-arduino-ide)
45-
- [Artemis Development with the Arduino IDE](https://learn.sparkfun.com/tutorials/artemis-development-with-the-arduino-ide)
46-
47-
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!
48-
49-
## Development Status
50-
51-
* v2.0.0 Based on an [mbed-os](https://github.com/ARMmbed/mbed-os) framework
52-
* v2.1.0 Contains latest fixes for the v2 core and feature that have been added since v2 release
53-
54-
For more information on how to contribute or how to navigate this repo, check out the [Contributing](./docs/CONTRIBUTING.md) page.
55-
56-
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](https://github.com/ARMmbed/mbed-os). 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](https://github.com/sparkfun/mbed-os-ambiq-apollo3/tree/ambiq-apollo3-arduino).
57-
58-
**Main Arduino Features**
59-
* Serial: ✅
60-
* GPIO: ✅
61-
* Analog / Servo Output: ✅
62-
* Analog Input: ✅
63-
* Timing / Delays: ✅
64-
65-
66-
**Standard Libraries**
67-
* Wire
68-
* Controller: ✅
69-
* Peripheral: 🤔
70-
* SPI
71-
* Controller: ✅
72-
* Peripheral: 🤔
73-
* EEPROM: ✅
74-
75-
**Apollo3 Specialty Peripherals**
76-
* PDM Microphones / I2S: ✅
77-
* BLE: ✅
78-
* RTC: ✅
79-
* Watchdog Timer: ✅
80-
* Burst Mode: ✅
81-
82-
## More
83-
### [License](./docs/LICENSE.md)
84-
### [Contributing](./docs/CONTRIBUTING.md)
85-
### [Issue Template](./docs/ISSUES.md)
86-
### [Acknowledgements](./docs/ACKNOWLEDGEMENTS.md)
8+
```https://raw.githubusercontent.com/SapphireCircuits/Arduino_Apollo3/main/package_SapphireCircuits_apollo3_plus_index.json```
9+
[https://raw.githubusercontent.com/SapphireCircuits/Arduino_Apollo3/main/package_SapphireCircuits_apollo3_plus_index.json](https://raw.githubusercontent.com/SapphireCircuits/Arduino_Apollo3/main/package_SapphireCircuits_apollo3_plus_index.json)
10+
- Open 'Boards Manager' and select 'Sapphire Circuits Apollo3 Plus Boards' - install the latest version

docs/ACKNOWLEDGEMENTS.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/CONTRIBUTING.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

docs/ISSUES.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/LICENSE.md

Lines changed: 43 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,56 @@
1-
SparkFun License Information
2-
============================
3-
4-
SparkFun uses two different licenses for our files — one for hardware and one for code.
5-
1+
Sapphire Circuits Artemis Plus License Information
2+
===================================================
63
Hardware
74
---------
5+
In accordance with the terms of the Attribution-ShareAlike 4.0 International License (http://creativecommons.org/licenses/by-sa/4.0/), the Sapphire Circuits Artemis Plus remix of the SparkFun Artemis Module is distributed under the same license.
86

9-
**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
7+
Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
8+
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
9+
You are free to:
1010

11-
Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
11+
Share — copy and redistribute the material in any medium or format
12+
Adapt — remix, transform, and build upon the material
13+
for any purpose, even commercially.
1214

13-
You are free to:
15+
This license is acceptable for Free Cultural Works.
16+
17+
The licensor cannot revoke these freedoms as long as you follow the license terms.
1418

15-
Share — copy and redistribute the material in any medium or format
16-
Adapt — remix, transform, and build upon the material
17-
for any purpose, even commercially.
18-
The licensor cannot revoke these freedoms as long as you follow the license terms.
1919
Under the following terms:
2020

21-
Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
22-
ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
23-
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
21+
Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
22+
23+
ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
24+
25+
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
26+
2427
Notices:
2528

26-
You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
27-
No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
29+
You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
30+
No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
31+
32+
33+
As required, proper attribution for the original design is provided below:
2834

35+
Attribution:
36+
Original Design Attributed To: SparkFun Electronics
37+
Schematic Designed By: SparkFun Electronics, N. Seidle (Designer Name As Listed In Schematic Title Block)
38+
PCB Layout Designed By: SparkFun Electronics, N. Seidle (Designer Name As Listed In Layers)
39+
40+
Modifications:
41+
The original design has been modified to use the Ambiq Apollo3 Blue Plus instead of the Ambiq Apollo3 Blue Microcontroller. Both micro-controllers have many pins, signals, and peripheral units in common. However, the micro-controllers have physically different dimensions as, ball sizes, and the Artemis Plus version has additional pins. Where possible, these pins were kept the same as to maintain as much compatibility as possible. The trace and space as well as the individual routing for the signals needed to be adjusted due to differences in the locations and pin sizes.
42+
43+
The original design files were designed in EAGLE, but for this remix it was imported into Altium Designer.
2944

3045
Code
3146
--------
32-
47+
**Sapphire Circuits code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).**
48+
which is the same license used by the original SparkFun code copied below.
3349
**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).**
3450

3551
The MIT License (MIT)
3652

37-
```
38-
Copyright (c) 2020 SparkFun Electronics
53+
Copyright (c) 2017 SparkFun Electronics
3954

4055
Permission is hereby granted, free of charge, to any person obtaining a copy
4156
of this software and associated documentation files (the "Software"), to deal
@@ -54,4 +69,11 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
5469
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
5570
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
5671
SOFTWARE.
57-
```
72+
73+
74+
75+
76+
77+
78+
79+

docs/RELEASE_PROCESS.MD

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)