| Tiago Barros | 0baa4d7 | 2016-09-06 15:09:14 -0300 | [diff] [blame] | 1 | KNoT Thing library |
| Claudio Takahasi | 00bdf94 | 2016-08-16 10:55:54 -0300 | [diff] [blame] | 2 | |
| Tiago Barros | 0baa4d7 | 2016-09-06 15:09:14 -0300 | [diff] [blame] | 3 | Copyright (c) 2016, CESAR. |
| 4 | All rights reserved. |
| 5 | |
| 6 | This software may be modified and distributed under the terms |
| 7 | of the BSD license. See the COPYING file for details. |
| 8 | |
| 9 | Introduction |
| 10 | ============ |
| 11 | |
| 12 | KNoT Thing library is a lightweight C/C++ library built to use minimal CPU |
| Larissa | 01921b9 | 2017-12-20 08:44:51 -0300 | [diff] [blame] | 13 | and memory resources. It is intended to run on KNoT Nodes (Things) (see KNoT |
| 14 | Architecture for better understanding). |
| Tiago Barros | 0baa4d7 | 2016-09-06 15:09:14 -0300 | [diff] [blame] | 15 | |
| 16 | It provides the Radio and Protocol abstractions for the application. The application |
| 17 | builder just need implement the read/write functions for its sensors/actuators, |
| 18 | register a Data Item (sensor or actuator) on the library and call the run() method |
| 19 | on its main loop routine. |
| 20 | |
| 21 | |
| 22 | |
| 23 | Compilation and installation |
| 24 | ============================ |
| 25 | |
| Larissa | 01921b9 | 2017-12-20 08:44:51 -0300 | [diff] [blame] | 26 | Currently the KNoT Thing library supports only the Arduino platform. The build process will generate an Arduino library zip file (KNoTThing.zip) containing all source code. This zip file can be imported on Arduino IDE. |
| Tiago Barros | 0baa4d7 | 2016-09-06 15:09:14 -0300 | [diff] [blame] | 27 | |
| 28 | In order to compiler the source code you need following software packages: |
| 29 | - GCC compiler |
| 30 | - GNU C library |
| 31 | |
| 32 | How to build: |
| 33 | make |
| 34 | |
| 35 | How to install: |
| Larissa | 01921b9 | 2017-12-20 08:44:51 -0300 | [diff] [blame] | 36 | Refer to Arduino library guide in order to install KNoT Thing library on Arduino IDE: https://www.arduino.cc/en/Guide/Libraries |
| 37 | |
| 38 | |
| 39 | |
| 40 | Thing Status LED |
| 41 | ================ |
| 42 | |
| 43 | The Thing Status LED is used to report connection status (disconnected / connecting / connected) and also error status (invalid initialization / authentication error). |
| 44 | |
| 45 | Here is the LED blinking scheme considering the connection status and error status: |
| 46 | |
| 47 | CONNECTION STATUS |
| 48 | |
| 49 | * Disconnected: Blink led continuously (1s on, 1s off) |
| 50 | * Connecting: Blink led twice (1s on, 1s off, twice) and 10s off after |
| 51 | * Connected: Blink led once (1s on, 10s off) |
| 52 | |
| 53 | ERROR STATUS |
| 54 | |
| 55 | * Name error: the user initialized KNoTThing with a null thing name. Blink led continuously with 50ms interval. |
| 56 | * HAL init error: the radio failed to initialize. Blink led continuously with 100ms interval. |
| 57 | * AUTH error: the thing failed to authenticate and need to reset its UUID/Token. Blink led continuously with 250ms interval. |