Giter VIP home page Giter VIP logo

iotsp-device-sdk-java's Introduction

device-sdk-java

This repository contains Cisco's IoT device SDK written in Java. Device SDKs are the applications which run on Cisco's gateways and enable you to extract observations from client devices connected to Cisco's gateways and send the information to Cisco Kinetic Data Delivery Platform. The Cisco gateways provide the application users with internet connectivity, application running on gateway which helps in device management and a secure platform to connect to Cisco's cloud.

To get started, clone this repository.

Overview

This repository contains sample applications and libraries for

S.No Application Name Explanation
1 iotsp-edge-rule-engine The iotsp-edge-rule-engine allows application developers to filter, process and send their data to different destinations. Sample project for Rule Engine On Edge
2 iotsp-batching The iotsp-batching allows application developers to filter, process and send their data to different destinations. The observations being sent to Cisco's cloud platform can be batched and compressed to save network bandwidth or it can be sent as it is immediately. Sample project for Batching
3 Pi-sensehat The Pi-Sensehat directory contains all the materials necessary to install the sensehat application on the raspberry pi. In this directory the readme contains instructions to install the application. The sensehat-app directory is to be installed into the home/pi/projects directory on the raspberry pi. This application is required on raspberri-pi if developers use raspberri-pi in above applications. Sample project for Pi-sensehat
4 iotsp-batching-multi-dcclient This application is similarly to iotsp-batching but uses multiple MQTT DC clients to achieve the job. It uses one client to publish observations, one for batched messages and one for special messages. Each MQTT client is created using a unique client id, so the MQTT broker allows multiple connections from same gateway. Batching with Multi DC Clients

How to use the Cisco IoT SDKs for Java

Connect your device to the gateway. The IoT device SDKs enable you to implement applications for a gateway. These gateways can be connected to any sort of device and can extract and process information received from these devices.

The application will run on Mac, Linux, IOx. To start developing these applications, refer documentation as shown below.

S.No Application Name Documentation
1 iotsp-edge-rule-engine Getting Started, Readme
2 iotsp-batching Getting Started, Readme
3 Pi-sensehat Readme
4 iotsp-batching-multi-dcclient Getting Started

Java docs for libraries

There are a number of libraries required in order to run sample applications - iotsp-edge-rule-engine and iotsp-batching. These libraries are stored here. The Javadoc for these libraries can be found here. In order to access any libraries Javadoc, run the following commands from root of the folder.

cd libs/javadoc-jars
mkdir tmpFolder
cp <Jar name of library whose java doc is to be accessed> tmpFolder/
cd tmpFolder/
jar -xvf <Jar name of library whose java doc is to be accessed>

Then navigate to this "tmpFolder" from your finder and open "index.html" using any web browser.

Sample Application

In this repository, you can find simple sample implementations that will kickstart your development.

S.No Application Name Sample Application
1 iotsp-edge-rule-engine Sample application for Rule Engine On Edge
2 iotsp-batching Sample application for Batching
3 iotsp-batching-multi-dcclient Sample application using multiple MQTT DC clients for Batching

Writing Rules

To write rules, please refer Cisco's tutorial on their DSL.

Directory Structure

Pi-Sensehat

  • The Pi-Sensehat directory contains all the materials necessary to install the sensehat application on the raspberry pi. In this directory the readme contains instructions to install the application. The sensehat-app directory is to be installed into the home/pi/projects directory on the raspberry pi.

examples

  • The examples directory contains two subdirectories - iotsp-batching and iotsp-edge-rule-engine. These directories contain information on how to install and run the sample applications. They also provide APIs and documentation on different options the sample applications provide and use.

libs

This directory contains libraries and their java-docs, necessary for runnning the above sample applications. It contains 2 folders:

  • lib-jars - This folder contains the library jars
  • javadoc jars - This folder contains java doc jars for all the libraries.

Change Log

Please find change log here.

Support

Please email all questions and feedback to [email protected]

iotsp-device-sdk-java's People

Contributors

bdegtyar avatar dhruvityagi avatar melindadevins avatar shashipavuluri avatar sherryxu avatar wendyhi avatar

Stargazers

 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

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.