Giter VIP home page Giter VIP logo

cesarbr / knot-thing-source Goto Github PK

View Code? Open in Web Editor NEW
11.0 11.0 22.0 389 KB

KNoT Thing library is a lightweight C/C++ library built to use minimal CPU and memory resources. It is intended to run on KNoT Nodes (Things) (see KNoT Architecture for better understanding). It provides the Radio and Protocol abstractions for the application. The application builder just need implement the read/write functions for its sensors/actuators, register a Data Item (sensor or actuator) on the library and call the run() method on its main loop routine.

License: Other

C 73.62% Makefile 15.11% C++ 10.56% Shell 0.71%

knot-thing-source's Introduction

KNoT Thing library

Copyright (c) 2016, CESAR. All rights reserved.

This software may be modified and distributed under the terms of the BSD license. See the COPYING file for details.

Introduction

KNoT Thing library is a lightweight C/C++ library built to use minimal CPU and memory resources. It is intended to run on KNoT Nodes (Things) (see KNoT Architecture for better understanding).

It provides the Radio and Protocol abstractions for the application. The application builder just need implement the read/write functions for its sensors/actuators, register a Data Item (sensor or actuator) on the library and call the run() method on its main loop routine.

Compilation and installation

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.

In order to compiler the source code you need following software packages:

  • GCC compiler
  • GNU C library

How to build:

make

How to install:

Refer to Arduino library guide in order to install KNoT Thing library on Arduino IDE: https://www.arduino.cc/en/Guide/Libraries

Thing Status LED

The Thing Status LED is used to report connection status (disconnected / connecting / connected) and also error status (invalid initialization / authentication error).

Here is the LED blinking scheme considering the connection status and error status:

CONNECTION STATUS

  • Disconnected: Blink led continuously (1s on, 1s off)
  • Connecting: Blink led twice (1s on, 1s off, twice) and 10s off after
  • Connected: Blink led once (1s on, 10s off)

ERROR STATUS

  • Name error: the user initialized KNoTThing with a null thing name. Blink led continuously with 50ms interval.
  • HAL init error: the radio failed to initialize. Blink led continuously with 100ms interval.
  • AUTH error: the thing failed to authenticate and need to reset its UUID/Token. Blink led continuously with 250ms interval.

knot-thing-source's People

Contributors

alla3 avatar cktakahasi avatar ericksimoes avatar fnba avatar hmscj-cesar avatar jcorde avatar lhcavalcanti avatar mpocin avatar otacilion avatar pauloserrafh avatar rodrigoalves1 avatar tgfb avatar vitbaq avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

knot-thing-source's Issues

Make file not caching all files

The files: knot_types.h, knot_protocol.h, and knot_protocol.c are not being inserted into the .zip file when the makefile is used. The files are in the download folder.

Improve markdown syntax

In order to improve the documentation readable the markdown syntax should be fixed, making the repository GitHub generated with the README.md preview prettier.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.