Skip to content

Commit d2a8d0a

Browse files
PaulZCPaulZC
committed
Initial commit
0 parents  commit d2a8d0a

9 files changed

+2984
-0
lines changed

‎.gitattributes

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto
3+
4+
# Custom for Visual Studio
5+
*.cs diff=csharp
6+
7+
# Standard to msysgit
8+
*.doc diff=astextplain
9+
*.DOC diff=astextplain
10+
*.docx diff=astextplain
11+
*.DOCX diff=astextplain
12+
*.dot diff=astextplain
13+
*.DOT diff=astextplain
14+
*.pdf diff=astextplain
15+
*.PDF diff=astextplain
16+
*.rtf diff=astextplain
17+
*.RTF diff=astextplain

‎.gitignore

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# IDE settings directories/folders
2+
.vscode/
3+
4+
# Windows image file caches
5+
Thumbs.db
6+
ehthumbs.db
7+
8+
# Folder config file
9+
Desktop.ini
10+
11+
# Recycle Bin used on file shares
12+
$RECYCLE.BIN/
13+
14+
# Windows Installer files
15+
*.cab
16+
*.msi
17+
*.msm
18+
*.msp
19+
20+
# Windows shortcuts
21+
*.lnk
22+
23+
# C build files
24+
_build
25+
*.elf
26+
*.hex
27+
*.exe
28+
29+
# Arduino CLI config file
30+
*.yml
31+
Makefile
32+
33+
# =========================
34+
# Operating System Files
35+
# =========================
36+
37+
# OSX
38+
# =========================
39+
40+
.DS_Store
41+
.AppleDouble
42+
.LSOverride
43+
44+
# Thumbnails
45+
._*
46+
47+
# Files that might appear in the root of a volume
48+
.DocumentRevisions-V100
49+
.fseventsd
50+
.Spotlight-V100
51+
.TemporaryItems
52+
.Trashes
53+
.VolumeIcon.icns
54+
55+
# Directories potentially created on remote AFP share
56+
.AppleDB
57+
.AppleDesktop
58+
Network Trash Folder
59+
Temporary Items
60+
.apdisk
61+
62+
# Test examples
63+
test

‎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

‎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) 2020 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.

‎README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
SparkFun u-blox SARA-R5 Arduino Library
2+
==============================
3+
4+
An Arduino library for the u-blox SARA-R5 LTE-M / NB-IoT modules with secure cloud, as used on the SparkFun MicroMod Asset Tracker
5+
6+
Repository Contents
7+
-------------------
8+
9+
* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE.
10+
* **/src** - Source files for the library (.cpp, .h).
11+
* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.
12+
* **library.properties** - General library properties for the Arduino package manager.
13+
14+
Documentation
15+
-------------
16+
17+
* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
18+
* **[Product Repository](https://github.com/sparkfun/MicroMod_Asset_Tracker)** - MicroMod Asset Tracker repository (including hardware files).
19+
* **[LICENSE.md](./LICENSE.md)** - License Information
20+
21+
- Your friends at SparkFun.

‎keywords.txt

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
#######################################
2+
# Syntax Coloring Map
3+
#######################################
4+
5+
#######################################
6+
# Datatypes KEYWORD1
7+
#######################################
8+
9+
SARA_R5 KEYWORD1
10+
mobile_network_operator_t KEYWORD1
11+
SARA_R5_error_t KEYWORD1
12+
SARA_R5_registration_status_t KEYWORD1
13+
DateData KEYWORD1
14+
TimeData KEYWORD1
15+
ClockData KEYWORD1
16+
PositionData KEYWORD1
17+
SpeedData KEYWORD1
18+
operator_stats KEYWORD1
19+
SARA_R5_socket_protocol_t KEYWORD1
20+
SARA_R5_message_format_t KEYWORD1
21+
22+
#######################################
23+
# Methods and Functions KEYWORD2
24+
#######################################
25+
26+
begin KEYWORD2
27+
day KEYWORD2
28+
month KEYWORD2
29+
year KEYWORD2
30+
hour KEYWORD2
31+
minute KEYWORD2
32+
second KEYWORD2
33+
ms KEYWORD2
34+
tzh KEYWORD2
35+
tzm KEYWORD2
36+
date KEYWORD2
37+
time KEYWORD2
38+
utc KEYWORD2
39+
lat KEYWORD2
40+
latDir KEYWORD2
41+
lon KEYWORD2
42+
lonDir KEYWORD2
43+
alt KEYWORD2
44+
mode KEYWORD2
45+
status KEYWORD2
46+
speed KEYWORD2
47+
track KEYWORD2
48+
magVar KEYWORD2
49+
magVarDir KEYWORD2
50+
stat KEYWORD2
51+
shortOp KEYWORD2
52+
longOp KEYWORD2
53+
numOp KEYWORD2
54+
act KEYWORD2
55+
begin KEYWORD2
56+
poll KEYWORD2
57+
setSocketReadCallback KEYWORD2
58+
setSocketCloseCallback KEYWORD2
59+
setGpsReadCallback KEYWORD2
60+
write KEYWORD2
61+
at KEYWORD2
62+
enableEcho KEYWORD2
63+
imei KEYWORD2
64+
imsi KEYWORD2
65+
ccid KEYWORD2
66+
reset KEYWORD2
67+
clock KEYWORD2
68+
autoTimeZone KEYWORD2
69+
rssi KEYWORD2
70+
registration KEYWORD2
71+
setNetwork KEYWORD2
72+
getNetwork KEYWORD2
73+
setAPN KEYWORD2
74+
getAPN KEYWORD2
75+
enterPPP KEYWORD2
76+
getOperators KEYWORD2
77+
registerOperator KEYWORD2
78+
getOperator KEYWORD2
79+
deregisterOperator KEYWORD2
80+
setSMSMessageFormat KEYWORD2
81+
sendSMS KEYWORD2
82+
setBaud KEYWORD2
83+
setGpioMode KEYWORD2
84+
getGpioMode KEYWORD2
85+
socketOpen KEYWORD2
86+
socketClose KEYWORD2
87+
socketConnect KEYWORD2
88+
socketWrite KEYWORD2
89+
socketWrite KEYWORD2
90+
socketRead KEYWORD2
91+
socketListen KEYWORD2
92+
IPAddress lastRemoteIP KEYWORD2
93+
boolean gpsOn KEYWORD2
94+
gpsPower KEYWORD2
95+
gpsEnableClock KEYWORD2
96+
gpsGetClock KEYWORD2
97+
gpsEnableFix KEYWORD2
98+
gpsGetFix KEYWORD2
99+
gpsGetFix KEYWORD2
100+
gpsEnablePos KEYWORD2
101+
gpsGetPos KEYWORD2
102+
gpsEnableSat KEYWORD2
103+
gpsGetSat KEYWORD2
104+
gpsEnableRmc KEYWORD2
105+
gpsGetRmc KEYWORD2
106+
gpsEnableSpeed KEYWORD2
107+
gpsGetSpeed KEYWORD2
108+
gpsRequest KEYWORD2
109+
110+
#######################################
111+
# Constants LITERAL1
112+
#######################################
113+
114+
SARA-R410M-02B LITERAL1
115+
MNO_INVALID LITERAL1
116+
MNO_SW_DEFAULT LITERAL1
117+
MNO_SIM_ICCD LITERAL1
118+
MNO_ATT LITERAL1
119+
MNO_VERIZON LITERAL1
120+
MNO_TELSTRA LITERAL1
121+
MNO_TMO LITERAL1
122+
MNO_CT LITERAL1
123+
SARA_R5_ERROR_INVALID LITERAL1
124+
SARA_R5_ERROR_SUCCESS LITERAL1
125+
SARA_R5_ERROR_OUT_OF_MEMORY LITERAL1
126+
SARA_R5_ERROR_TIMEOUT LITERAL1
127+
SARA_R5_ERROR_UNEXPECTED_PARAM LITERAL1
128+
SARA_R5_ERROR_UNEXPECTED_RESPONSE LITERAL1
129+
SARA_R5_ERROR_NO_RESPONSE LITERAL1
130+
SARA_R5_ERROR_DEREGISTERED LITERAL1
131+
SARA_R5_SUCCESS LITERAL1
132+
SARA_R5_REGISTRATION_INVALID LITERAL1
133+
SARA_R5_REGISTRATION_NOT_REGISTERED LITERAL1
134+
SARA_R5_REGISTRATION_HOME LITERAL1
135+
SARA_R5_REGISTRATION_SEARCHING LITERAL1
136+
SARA_R5_REGISTRATION_DENIED LITERAL1
137+
SARA_R5_REGISTRATION_UNKNOWN LITERAL1
138+
SARA_R5_REGISTRATION_ROAMING LITERAL1
139+
SARA_R5_REGISTRATION_HOME_SMS_ONLY LITERAL1
140+
SARA_R5_REGISTRATION_ROAMING_SMS_ONLY LITERAL1
141+
SARA_R5_REGISTRATION_HOME_CSFB_NOT_PREFERRED LITERAL1
142+
SARA_R5_REGISTRATION_ROAMING_CSFB_NOT_PREFERRED LITERAL1
143+
SARA_R5_TCP LITERAL1
144+
SARA_R5_UDP LITERAL1
145+
SARA_R5_MESSAGE_FORMAT_PDU LITERAL1
146+
SARA_R5_MESSAGE_FORMAT_TEXT LITERAL1
147+
GPIO1 LITERAL1
148+
GPIO2 LITERAL1
149+
GPIO3 LITERAL1
150+
GPIO4 LITERAL1
151+
GPIO5 LITERAL1
152+
GPIO6 LITERAL1
153+
GPIO_MODE_INVALID LITERAL1
154+
GPIO_OUTPUT LITERAL1
155+
GPIO_INPUT LITERAL1
156+
NETWORK_STATUS LITERAL1
157+
GNSS_SUPPLY_ENABLE LITERAL1
158+
GNSS_DATA_READY LITERAL1
159+
GNSS_RTC_SHARING LITERAL1
160+
SIM_CARD_DETECTION LITERAL1
161+
HEADSET_DETECTION LITERAL1
162+
GSM_TX_BURST_INDICATION LITERAL1
163+
MODULE_OPERATING_STATUS_INDICATION LITERAL1
164+
MODULE_FUNCTIONALITY_STATUS_INDICATION LITERAL1
165+
I2S_DIGITAL_AUDIO_INTERFACE LITERAL1
166+
SPI_SERIAL_INTERFACE LITERAL1
167+
MASTER_CLOCK_GENRATION LITERAL1
168+
UART_INTERFACE LITERAL1
169+
WIFI_ENABLE LITERAL1
170+
RING_INDICATION LITERAL1
171+
LAST_GASP_ENABLE LITERAL1
172+
PAD_DISABLED LITERAL1

‎library.properties

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name=SparkFun u-blox SARA-R5 Arduino Library
2+
version=1.0.0
3+
author=SparkFun Electronics <techsupport@sparkfun.com>
4+
maintainer=SparkFun Electronics <sparkfun.com>
5+
sentence=Library for the u-blox SARA-R5 LTE-M / NB-IoT modules with secure cloud
6+
paragraph=An Arduino library for the u-blox SARA-R5 LTE-M / NB-IoT modules with secure cloud, as used on the SparkFun MicroMod Asset Tracker.
7+
category=Communication
8+
url=https://github.com/sparkfun/SparkFun_u-blox_SARA-R5_Arduino_Library
9+
architectures=*

0 commit comments

Comments
 (0)