Skip to content

terryoba/devify-server

 
 

Repository files navigation

A new way to write IoT application server code.

devify-server

Join the chat at https://gitter.im/DevifyPlatform/devify-server Build Status GitHub license

devify-server, or Devify in a short, is a simple IoT server boilerplate.

Devify is extremely light weight, and is very easy to use. It aims to help developers to create IoT application servers, faster.

Introduction

Devify is an open source project to develop the boilerplates for getting started with IoT cloud servers. It gets you up to speed using IoT and web technologies.

Devify open source project, or Devify, is a software framework. Its goal is to create a new way to write IoT server code.

Quickstart

A cli tool devify-cli is available for getting started with devify.

$ npm install -g devify-cli
$ devify new <new_project_dir>
$ cd <new_project_dir> && npm install
$ node esp8266-coap-server.js 

Tutorial

This section introduces a new way to write a CoAP server for getting data from an NodeMCU (ESP8266) device.

The following instructions show how to connect NodeMCU to your localhost (PC/Notebook) and send ADC data to localhost over CoAP.

1. Get devify-cli

$ npm install -g devify-cli 

devify-cli a cli app aimed to get you speed up.

2. Create a new project

$ devify esp_air_iot

Create a new Devify project by devify-cli. Devify-cli will automatically create a new folder and download the project template at this folder. The folder name is esp_air_iot at this example.

Please make sure that git was installed at your host.

3. Install dependencies

$ cd esp_air_iot && npm install

Devify project template is an isomorphic JavaScript app using Node.js. Please run npm install to get Node.js modules installed.

4. Start the server

You need to export the host IP through HOST environment variable before starting the CoAP server.

$ export HOST=192.168.0.100
$ node esp8266-coap-server.js 
WoT/CoAP server is listening at coap://192.168.0.100:8000

The message shows that the server is listening at coap://192.168.0.100:8000.

5. Programing IoT device

The simplest way to send sensor data to IoT server via CoAP is using NodeMCU and Lua programming language.

-- Configure the ESP as a station (client)
wifi.setmode(wifi.STATION)  
wifi.sta.config("<SSID>", "<PASSWORD>")  
wifi.sta.autoconnect(1)

-- Create a CoAP client
cc = coap.Client()

-- Make a POST request
uri="coap://192.168.0.100:8000/object/12345678/send"

-- Setup a timer to send ADC data
tmr.alarm(0, 1000, 1, function() 
    buf = 
          "{" ..
          "\"quality\":" ..
          adc.read(0) ..
          "}"
    
    cc:post(uri, buf)
    print(buf)
end)

Developer

There are several IoT server templates with different use scenraio. Please go to the ebook ESP8266 over the Web: Getting started with IoT System Architecture.

Deploy to Azure

Before start to use devify-server and continue to develop your own. You can have the first experience of devify-server by deploying this basic devify-server boilerplate to Azure.

  • Please click above button for one click to azure. Be sure to Enable Web Sockets after deploying your web site.

  • Go to the Windows Azure Management Console

  • Select App Services

  • Select your web site, and go to the All settings page

  • Scroll down and select Application settings in the GENERAL label

  • Scroll down and switch the button of Web sockets to On

  • Click the Save icon

  • Use your web site URL to access Devify server.

  • Go to the Windows Azure Management Console

  • Select App Services

  • Select your web site

  • Find URL here, for example devify-server88de.azurewebsites.net

  • Use WebSocket broker server.

  • Open test/test.websocket.send.js file

  • Modify this line: client.connect('ws://localhost:8000/object/5550937980d51931b3000009/send', ''); to meet your web site URL. For the example above client.connect('ws://devify-server88de.azurewebsites.net/object/5550937980d51931b3000009/send', '');

  • The Devify framework will generate a URI for sending the received messages, use ws://devify-server88de.azurewebsites.net/object/5550937980d51931b3000009/viewer to receive real-time messages from the server.

  • The string 5550937980d51931b3000009 is the device ID. You can modify it and give a favor string.

Contribution

Devify is still under development. This project needs your help and contribution.

License

devify-server is released under the MIT License.

About

Extremely light weight IoT server boilerplate

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 91.0%
  • Lua 7.2%
  • Shell 1.4%
  • Makefile 0.4%