diff --git a/.gitignore b/.gitignore index 4581ef2..afdd800 100644 --- a/.gitignore +++ b/.gitignore @@ -1,29 +1,19 @@ -# Compiled Object files -*.slo -*.lo +# Compiled files, executables *.o -*.obj - -# Precompiled Headers -*.gch -*.pch - -# Compiled Dynamic libraries -*.so -*.dylib -*.dll - -# Fortran module files -*.mod -*.smod - -# Compiled Static libraries -*.lai -*.la *.a -*.lib - -# Executables *.exe *.out *.app + +# Junk +*.orig +*.log +*.bak + +# IDE project files +.cproject +.project +.settings + +# Markers +.development diff --git a/README.md b/README.md index fdb5389..5bf2ee5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ -# TinyGSM +``` + _______ _____ __ _ __ __ ______ _______ _______ + | | | \ | \_/ | ____ |______ | | | + | __|__ | \_| | |_____| ______| | | | + +``` + A small Arduino library for GPRS modules, that just works + +Currently only SIM800/SIM900 are tested. +More modules may be supported later. + +## Getting started + + 1. Using your phone: + - Disable PIN code on the SIM card + - Check your ballance + - Check that APN,User,Pass are correct and you have internet + 2. Ensure the sim card is correctly inserted into the module + 3. Provide a good, stable power supply (up to 2A) + (4.0-4.2V or 5V according to your module documentation) + 4. Provide good, stable serial connection + (Hardware Serial is recommended) + 5. Check if GSM antenna is attached + +__________ + +### License +This project is released under +The GNU Lesser General Public License (LGPL-3.0) diff --git a/keywords.txt b/keywords.txt new file mode 100644 index 0000000..931fdf1 --- /dev/null +++ b/keywords.txt @@ -0,0 +1,17 @@ +####################################### +# Data types (KEYWORD1) +####################################### +TinyGsmClient KEYWORD1 + +####################################### +# Methods and Functions (KEYWORD2) +####################################### +begin KEYWORD2 +restart KEYWORD2 +networkConnect KEYWORD2 +networkDisconnect KEYWORD2 +factoryReset KEYWORD2 + +####################################### +# Literals (LITERAL1) +####################################### diff --git a/library.json b/library.json new file mode 100644 index 0000000..0b17528 --- /dev/null +++ b/library.json @@ -0,0 +1,24 @@ +{ + "name": "TinyGSM", + "version": "0.1.0", + "description": "A small Arduino library for GPRS modules, that just works. Includes examples for Blynk, MQTT, File Download, and Web Client. Supports GSM modules, that work over AT command interface: SIM800, SIM800L, SIM900", + "keywords": "GSM, SIM800, SIM800L, SIM900, AT commands, AT", + "authors": + { + "name": "Volodymyr Shymanskyy", + "url": "https://github.com/vshymanskyy", + "maintainer": true + }, + "repository": + { + "type": "git", + "url": "https://github.com/vshymanskyy/TinyGSM.git" + }, + "homepage": "https://github.com/vshymanskyy/TinyGSM", + "export": { + "exclude": [ "extras", "tools" ] + }, + "frameworks": [ "arduino", "energia", "wiringpi" ], + "platforms": "*", + "examples": "examples/*/*.ino" +} diff --git a/library.properties b/library.properties new file mode 100644 index 0000000..dd045c3 --- /dev/null +++ b/library.properties @@ -0,0 +1,9 @@ +name=TinyGSM +version=0.1.0 +author=Volodymyr Shymanskyy +maintainer=Volodymyr Shymanskyy +sentence=A small Arduino library for GPRS modules, that just works. +paragraph=Includes examples for Blynk, MQTT, File Download, and Web Client. Supports GSM modules, that work over AT command interface: SIM800, SIM800L, SIM900 +category=Communication +url=https://github.com/vshymanskyy/TinyGSM +architectures=*