Skip to content

Commit fe47ad0

Browse files
authored
Merge pull request #57 from sakuraio/feat/detailed_comment
Add link to datasheet in examples and README
2 parents 632be8e + 2ef4aff commit fe47ad0

5 files changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ void loop() {
8787
8888
## Methods
8989
90+
Please check the [datasheet](https://sakura.io/developer/pdf/sakura_module_datasheet_latest.pdf) to see what each method is actually doing.
91+
9092
```cpp
9193
// Common
9294
uint8_t getConnectionStatus();

examples/FileDownload/FileDownload.ino

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
/*
2+
* sakura.io file distrobution (file download) example
3+
*
4+
* For detailed command information please see the datasheet.
5+
* https://sakura.io/developer/pdf/sakura_module_datasheet_latest.pdf
6+
*/
7+
8+
19
#include <SakuraIO.h>
210

311
#define FILE_ID 1

examples/FirmwareUpdate/FirmwareUpdate.ino

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
/*
2+
* sakura.io firmware update example
3+
*
4+
* For detailed command information please see the datasheet.
5+
* https://sakura.io/developer/pdf/sakura_module_datasheet_latest.pdf
6+
*/
7+
18
#include <SakuraIO.h>
29

310
//SakuraIO_SPI sakuraio(10);

examples/Shell/Shell.ino

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
/*
2+
* sakura.io shell example
3+
*
4+
* For detailed command information please see the datasheet.
5+
* https://sakura.io/developer/pdf/sakura_module_datasheet_latest.pdf
6+
*/
7+
18
#include <SakuraIO.h>
29
#include "ntshell.h"
310
#include "commands.h"

examples/Standard/Standard.ino

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
/*
2+
* sakura.io simple example
3+
*
4+
* For detailed command information please see the datasheet.
5+
* https://sakura.io/developer/pdf/sakura_module_datasheet_latest.pdf
6+
*/
7+
18
#include <SakuraIO.h>
29

310
//SakuraIO_SPI sakuraio(10);

0 commit comments

Comments
 (0)