Skip to content

jamsden/iot-service

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

iot-service

A Node.js module providing Express middleware to create an OSLC 3.0 server to access IoT platform and/or dev resources. The service uses:

  1. the oslc-service Express middleware module which provides
  2. the ldp-service Express middleware service
  3. MongoDB for persistence, jsonld.js for JSON-LD support, and a few other JavaScript libraries.

A sample app using the OSLC middleware service is running at http://iot-server.mybluemix.net.

iot-service provides extensions to oslc-service that adapts IoT Platform resources to their equivalent OSLC domain resources.

Many thanks to Steve Speicher and Sam Padgett for their valuable contribution to LDP and the LDP middleware upon which this service is built.

Module planning, maintenance and issues can be see at at the iot-service IBM Bluemix DevOps Services project.

Using

  1. Install the required modules

Install Node.js.

Install and start MongoDB.

Install express.js and create a sample express app

$ npm install express -g
$ express --git -e <appDir>
  1. Edit the package.json file to add a dependency on ldp-service

    "dependencies": {"ldp-service": "~0.0.1"},

  2. Edit app.js and add whatever Express middleware you need including oslc-service. oslc-service also utilizes ldp-service which provides access to a MongoDB database in case additional middleware needs direct access to the database.

    var ldpService = require('ldp-service'); app.use(ldpService()); var db = ldpService.db; // in case further middleware needs access to the database

  3. Configuration defaults can be found in config.json. These may be overridden by variables in the environment, including Bluemix variables if deployed in a Bluemix app.

  4. To start the app, run these commands

    $ npm install $ node app.js

Finally, point your browser to http://localhost:3000/.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

Create Node/Express middleware component to provide an OSLC adapter for the IBM Watson IoT Platform resources

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published