You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-3Lines changed: 14 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,8 @@ Smart Citizen Kit
15
15
16
16
### Quick start
17
17
18
+
* Visit the project main documentation. [docs.smartcitizen.me](https://docs.smartcitizen.me)
19
+
18
20
* Visit the project [wiki](https://github.com/fablabbcn/Smart-Citizen-Kit/wiki)
19
21
20
22
### Loading Firmware
@@ -27,7 +29,9 @@ Smart Citizen Kit
27
29
28
30
### Versions
29
31
30
-
The current firmware version in use is `0.8.6`.
32
+
The current firmware version in use is `0.9.0`.
33
+
34
+
We currently support the SD card version on as a diferent firmware `SDCARD`, currently `0.8.6 SDCARD`.
31
35
32
36
You can see the release history [here](https://github.com/fablabbcn/Smart-Citizen-Kit/releases)
33
37
@@ -36,8 +40,15 @@ You can see the release history [here](https://github.com/fablabbcn/Smart-Citize
36
40
* Setup commands reference in [sck-commands.md](https://github.com/fablabbcn/Smart-Citizen-Kit/blob/master/sck-commands.md)
37
41
38
42
* Basic documentation for creating your own Sensor Boards [here](https://github.com/fablabbcn/Smart-Citizen-Kit/wiki/Making-a-Shield)
39
-
<<<<<<< HEAD
40
43
41
-
### Support
44
+
### Support and issues
42
45
43
46
* Forum [forum.smartcitizen.me](http://forum.smartcitizen.me)
47
+
48
+
### Contributions
49
+
50
+
* We are working on improving the firmware documentation for developers but still we encourage you to Fork the project and do a Pull request with your contributions.
The Smart Citizen Kit can be managed over a basic serial protocol. You just need the **Arduino IDE Serial Monitor** or any other **Serial Utility** like **Screen** in order to use it.
4
+
5
+
#### How to use it.
6
+
7
+
* Connect to your kit using any serial utility, any baud-rate should work but `115200` is recommendable.
8
+
* Send the starting commands.
9
+
* Notice all the commands except the starting commands require a carriage return at the end: `CR` or `\r` .
10
+
* Call any command you want, change `XXX` with the corresponding value.
2
11
3
12
### Basic SCK setup commands
4
13
5
-
*`$$$` Wake up the module and activate the Wi-Fi
14
+
This commands are commands to talk directly to the Wi-Fi module (RN-XV WiFly) own interface.
15
+
16
+
*`$$$` Wake up the module and enter WiFly commands mode
6
17
*`set wlan ssid XXX\r` Add a new SSID to memory
7
18
*`set wlan phrase XXX\r` Add a new phrase to memory
8
-
*`set wlan key XXX\r` Add a new key to memmory
19
+
*`set wlan key XXX\r` Add a new key to memory
9
20
*`set wlan auth XXX\r` Add an authentication method into memory
10
-
*`set wlan ext_antenna XXX\r` Add an antenna type into memmory
11
-
*`get mac\r` Get the MAC address of the kit
21
+
*`set wlan ext_antenna XXX\r` Add an antenna type into memory
12
22
*`exit\r` Go back to normal operational mode
13
23
14
-
15
24
### Special SCK commands
16
25
26
+
This commands are commands to talk talk to the SCK configuration interface.
27
+
28
+
*`###` Wake up the module and enter SCK commands mode
29
+
*`get mac\r` Get the MAC address of the kit
17
30
*`get time update\r` Retrieve the sensor update interval
18
-
*`set time update XXX\r`Update the sensor update interval
19
-
*`get number updates\r`Retrieve the max number of bulk updates allowed
31
+
*`set time update XXX\r` Update the sensor update interval
32
+
*`get number updates\r` Retrieve the max number of bulk updates allowed
20
33
*`set number updates XXX\r` Update the max number of bulk updates allowed
21
34
*`get apikey\r` Retrieve the kit APIKEY
22
35
*`set apikey XXX\r` Update the kit APIKEY
@@ -26,4 +39,4 @@ Change XXX with the corresponding value.
26
39
*`get wlan ext_antenna\r` Retrieve the antenna types saved on the kit
27
40
*`clear nets\r` Remove all saved Wi-Fi configuration information
28
41
*`exit\r` Goes back to normal operational mode
29
-
*`#data\r`Retrieves sensor readings stored in memory
42
+
*`#data\r` Retrieves sensor readings stored in memory
0 commit comments