Skip to content

Commit 29637ba

Browse files
oclykeoclyke
committed
Formatting
1 parent f7d1da2 commit 29637ba

File tree

7 files changed

+193
-19
lines changed

7 files changed

+193
-19
lines changed

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# VSCode
2+
.vscode

‎README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* [Development Status]()
77
* [Installation]()
88
* [Issue Template]()
9+
* [Repo Contents]()
910
* [Acknowledgements]()
1011

1112
## Development Status
@@ -29,4 +30,20 @@ The structure of this repo is such that it will most closely resemble the struct
2930
* Download the .ZIP of this repository
3031
* Within ```SparkFun``` create the ```apollo3``` directory
3132
* Unzip the contents of the .ZIP into the ```apollo3``` directory
32-
* Restart Arduino IDE for good measure
33+
* Restart Arduino IDE for good measure
34+
35+
## Issue Template
36+
=================
37+
38+
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.md to guide your report.
39+
40+
41+
## Repo Contents
42+
================
43+
* cores : source code and headers common to all Apollo3 Arduino boards
44+
* docs :
45+
* CONTRIBUTING.md
46+
* ISSUE_TEMPLATE.md
47+
* LICENSE.md
48+
* libraries : common source code for optional libraries that pertain to Apollo3 HW
49+
* variants : pin mapping and capability listing for individual boards

‎boards.txt

Lines changed: 75 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,97 @@
1+
# Copyright (c) 2019 SparkFun Electronics
12

3+
# Permission is hereby granted, free of charge, to any person obtaining a copy
4+
# of this software and associated documentation files (the "Software"), to deal
5+
# in the Software without restriction, including without limitation the rights
6+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
# copies of the Software, and to permit persons to whom the Software is
8+
# furnished to do so, subject to the following conditions:
29

3-
edge.name=Owen's SparkFun Edge
10+
# The above copyright notice and this permission notice shall be included in all
11+
# copies or substantial portions of the Software.
12+
13+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
# SOFTWARE.
20+
21+
###############################################################
22+
23+
amap3bare.name=Ambiq Apollo3 Bare
24+
amap3bare.build.variant=Ambiq_Apollo3_Bare
25+
amap3bare.build.board=AM_AP3_BARE
26+
amap3bare.build.arch=APOLLO3
27+
amap3bare.build.mcu=cortex-m4
28+
amap3bare.build.f_cpu=48000000L
29+
amap3bare.build.core=arduino
30+
amap3bare.build.defs=
31+
amap3bare.build.includes=-I{build.variant.path}/bsp
32+
amap3bare.build.libs=
33+
amap3bare.build.extra_flags=-DPART_apollo3 -DAM_PACKAGE_BGA -DAM_PART_APOLLO3
34+
amap3bare.build.ldscript={build.variant.path}/linker_scripts/gcc/flash_with_bootloader.ld
35+
amap3bare.upload.maximum_size=960000
36+
37+
###############################################################
38+
39+
amap3evb.name=Ambiq Apollo3 Evaluation Board
40+
amap3evb.build.variant=Ambiq_Apollo3_EVB
41+
amap3evb.build.board=AM_AP3_EVB
42+
amap3evb.build.arch=APOLLO3
43+
amap3evb.build.mcu=cortex-m4
44+
amap3evb.build.f_cpu=48000000L
45+
amap3evb.build.core=arduino
46+
amap3evb.build.defs=
47+
amap3evb.build.includes=-I{build.variant.path}/bsp
48+
amap3evb.build.libs=
49+
amap3evb.build.extra_flags=-DPART_apollo3 -DAM_PACKAGE_BGA -DAM_PART_APOLLO3
50+
amap3evb.build.ldscript={build.variant.path}/linker_scripts/gcc/flash_with_bootloader.ld
51+
amap3evb.upload.maximum_size=960000
52+
53+
###############################################################
54+
55+
artemis.name=SparkFun Artemis Module
56+
artemis.build.variant=SparkFun_Artemis
57+
artemis.build.board=SFE_ARTEMIS
58+
artemis.build.arch=APOLLO3
59+
artemis.build.mcu=cortex-m4
60+
artemis.build.f_cpu=48000000L
61+
artemis.build.core=arduino
62+
artemis.build.defs=
63+
artemis.build.includes=-I{build.variant.path}/bsp
64+
artemis.build.libs=
65+
artemis.build.extra_flags=-DPART_apollo3 -DAM_PACKAGE_BGA -DAM_PART_APOLLO3
66+
artemis.build.ldscript={build.variant.path}/linker_scripts/gcc/flash_with_bootloader.ld
67+
artemis.upload.maximum_size=960000
68+
69+
###############################################################
70+
71+
edge.name=SparkFun Edge
472
edge.build.variant=SparkFun_Edge
5-
edge.build.board=SFE_APOLLO3_EDGE
73+
edge.build.board=SFE_EDGE
674
edge.build.arch=APOLLO3
775
edge.build.mcu=cortex-m4
876
edge.build.f_cpu=48000000L
977
edge.build.core=arduino
10-
1178
edge.build.defs=
1279
edge.build.includes=-I{build.variant.path}/bsp
1380
edge.build.libs=
14-
1581
edge.build.extra_flags=-DPART_apollo3 -DAM_PACKAGE_BGA -DAM_PART_APOLLO3
1682
edge.build.ldscript={build.variant.path}/linker_scripts/gcc/flash_with_bootloader.ld
17-
18-
19-
2083
edge.upload.maximum_size=960000
2184
#edge.upload.tool=bossac
2285
#edge.upload.protocol=sam-ba
23-
2486
#edge.upload.use_1200bps_touch=true
2587
#edge.upload.wait_for_upload_port=true
2688
#edge.upload.native_usb=true
27-
28-
2989
#edge.build.usb_product="SFE SAMD21"
3090
#edge.build.usb_manufacturer="SparkFun"
31-
32-
33-
3491
#edge.build.openocdscript=openocd_scripts/arduino_zero.cfg
35-
36-
# edge.build.variant_system_lib=
37-
edge.build.extra_combine_flags=
92+
#edge.build.variant_system_lib=
93+
#edge.build.extra_combine_flags=
3894
#edge.bootloader.tool=openocd
39-
#edge.bootloader.file=zero/SparkFun_Edge.bin=
95+
#edge.bootloader.file=zero/SparkFun_Edge.bin=
96+
97+
###############################################################

‎docs/CONTRIBUTING.md

Whitespace-only changes.

‎docs/ISSUE_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
### Subject of the issue
2+
Describe your issue here.
3+
4+
### Your workbench
5+
* What platform are you using?
6+
* What version of the device are you using? Is there a firmware version?
7+
* How is the device wired to your platform?
8+
* How is everything being powered?
9+
* Are there any additional details that may help us help you?
10+
11+
### Steps to reproduce
12+
Tell us how to reproduce this issue. Please post stripped down example code demonstrating your issue to a gist.
13+
14+
### Expected behaviour
15+
Tell us what should happen
16+
17+
### Actual behaviour
18+
Tell us what happens instead

‎docs/LICENSE.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
SparkFun License Information
2+
============================
3+
4+
SparkFun uses two different licenses for our files — one for hardware and one for code.
5+
6+
Hardware
7+
---------
8+
9+
**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
10+
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).
12+
13+
You are free to:
14+
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.
19+
Under the following terms:
20+
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.
24+
Notices:
25+
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.
28+
29+
30+
Code
31+
--------
32+
33+
**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).**
34+
35+
The MIT License (MIT)
36+
37+
Copyright (c) 2016 SparkFun Electronics
38+
39+
Permission is hereby granted, free of charge, to any person obtaining a copy
40+
of this software and associated documentation files (the "Software"), to deal
41+
in the Software without restriction, including without limitation the rights
42+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
43+
copies of the Software, and to permit persons to whom the Software is
44+
furnished to do so, subject to the following conditions:
45+
46+
The above copyright notice and this permission notice shall be included in all
47+
copies or substantial portions of the Software.
48+
49+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
50+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
51+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
52+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
53+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
54+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
55+
SOFTWARE.

‎platform.txt

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
1-
name=Owens SparkFun Apollo3 Boards
1+
# The MIT License (MIT)
2+
3+
# Copyright (c) 2019 SparkFun Electronics
4+
# Contributors:
5+
# Owen Lyke
6+
7+
# Permission is hereby granted, free of charge, to any person obtaining a copy
8+
# of this software and associated documentation files (the "Software"), to deal
9+
# in the Software without restriction, including without limitation the rights
10+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
# copies of the Software, and to permit persons to whom the Software is
12+
# furnished to do so, subject to the following conditions:
13+
14+
# The above copyright notice and this permission notice shall be included in all
15+
# copies or substantial portions of the Software.
16+
17+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23+
# SOFTWARE.
24+
25+
name=SparkFun Apollo3
226
version=1.0.0
327

428

0 commit comments

Comments
 (0)