Skip to content

Commit c3bf2c7

Browse files
committed
Updated README.md, docs, and version bump to 1.1.0
1 parent ba7e1ad commit c3bf2c7

File tree

4 files changed

+10
-6
lines changed

4 files changed

+10
-6
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[![Build Status](https://travis-ci.org/blemasle/arduino-sim808.svg?branch=master)](https://travis-ci.org/blemasle/arduino-sim808)
33
[![License](https://img.shields.io/badge/license-MIT%20License-blue.svg)](http://doge.mit-license.org)
44

5-
This library allows to access some of the features of the [SIM808](https://simcom.ee/documents/?dir=SIM808) GPS & GPRS module. It requires at least 3 pins (power, status and reset pins) to work and a TTL Serial.
5+
This library allows to access some of the features of the [SIM808](https://simcom.ee/documents/?dir=SIM808) GPS & GPRS module. It requires only the `RESET` pin to work and a TTL Serial. `STATUS` pin can be wired to enhance the module power status detection, while wiring the `PWRKEY` adds the ability to turn the module on & off.
66

77
The library tries to reduces memory consumption as much as possible, but nonetheless use a 64 bytes buffer to communicate with the SIM808 module. When available, SIM808 responses are parsed to ensure that commands are correctly executed by the module. Commands timeouts are also set according to SIMCOM documentation.
88

@@ -46,17 +46,19 @@ It does *not* have the pretention to become the new SIM808 standard library, but
4646

4747
SoftwareSerial simSerial = SoftwareSerial(SIM_TX, SIM_RX)
4848
SIM808 sim808 = SIM808(SIM_RST, SIM_PWR, SIM_STATUS);
49+
// SIM808 sim808 = SIM808(SIM_RST); // if you only have the RESET pin wired
50+
// SIM808 sim808 = SIM808(SIM_RST, SIM_PWR); // if you only have the RESET and PWRKEY pins wired
4951

5052
void setup() {
5153
simSerial.begin(SIM808_BAUDRATE);
5254
sim808.begin(simSerial);
5355

54-
sim808.powerOnOff(true); //power on the SIM808
56+
sim808.powerOnOff(true); //power on the SIM808. Unavailable without the PWRKEY pin wired
5557
sim808.init();
5658
}
5759

5860
void loop() {
59-
//whatever you need to do
61+
// whatever you need to do
6062
}
6163
```
6264
See examples for further usage.

examples/Tester/Tester.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ void power() {
171171
return;
172172
}
173173

174-
Log.notice(S_F("%s : %S"), buffer, status ? TO_F(ON) : TO_F(OFF));
174+
Log.notice(S_F("%s : %S" NL), buffer, status ? TO_F(ON) : TO_F(OFF));
175175
}
176176
else if(BUFFER_IS_P(ON)) {
177177
readNext();

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=SIM808
2-
version=1.0.0
2+
version=1.1.0
33
author=Bertrand Lemasle
44
maintainer=Bertrand Lemasle
55
sentence=Straightforward Arduino library for the SIM808

src/SIM808.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,13 @@ class SIM808 : public SIMComAT
5454

5555
/**
5656
* Get a boolean indicating wether or not the device is currently powered on.
57+
* The power state is read from either the statusPin if set, or from a test AT command response.
5758
*/
5859
bool powered();
5960
/**
6061
* Power on or off the device only if the requested state is different than the actual state.
61-
* Returns true if the power state has been changed has a result of this call.
62+
* Returns true if the power state has been changed as a result of this call.
63+
* Unavailable and returns false in all cases if pwrKeyPin is not set.
6264
*
6365
* See powered()
6466
*/

0 commit comments

Comments
 (0)