Skip to content

City Data Exchange & Analytics Stack (CDEAS) for Smart Cities

Notifications You must be signed in to change notification settings

rbccps-iisc/ideam

Folders and files

NameName
Last commit message
Last commit date
Apr 2, 2018
Apr 9, 2018
Apr 9, 2018
Jan 4, 2018
Mar 22, 2018
Apr 2, 2018
Mar 7, 2018
Apr 9, 2018
Apr 9, 2018
Apr 2, 2018
Apr 2, 2018
Apr 9, 2018
Nov 4, 2017
Nov 4, 2017
Mar 7, 2018
Apr 2, 2018
Apr 2, 2018
Apr 9, 2018
Mar 7, 2018
Apr 2, 2018
Jan 8, 2018

Repository files navigation

IoT Data Exchange & Analytics Middleware (IDEAM) for Smart Cities

https://travis-ci.org/rbccps-iisc/ideam.svg?branch=master

Web Page

Architecture

https://rbccps.org/smartcity/lib/exe/fetch.php?media=mw_architecture.png

Requirements

Release

ideam v1.0.0

Use the ideam deb file to install in Linux machines after satisfying the requirements. dpkg -i ideam.deb .

Configuration

ideam.conf v1.0.0

  • Config file is located at /etc/ideam/ideam.conf.
  • The data files or docker persistent storage is at /var/ideam/data directory.
  • The persistent storage can be changed by modifying the ideam.conf before installation.

Steps to Install

After downloading and installing the deb file, do the following steps.

Installation ideam install or if you cloned ./ideam install
Start Ideam ideam start or if you cloned ./ideam start
Serving Ideam at https://localhost:10443
  • The application will be serving with a self-signed certificate. If you want to use your certificate, have your .crt and .key file as /usr/share/ideam/config/kong/default_443.crt and /usr/share/ideam/config/kong/default_443.key respectively and do a fresh installation.
  • If installation fails at some instance, all the time-dated logs are available at /tmp/ideam-%Y-%m-%d-%H-%M.log.

IDEAM API ENDPOINTS

Register
POST /api/1.0.0/register
Publish
POST /api/1.0.0/publish
Follow
POST /api/1.0.0/follow
Share
POST /api/1.0.0/share
Subscribe
GET /api/1.0.0/subscribe
Catalogue
GET /api/1.0.0/cat
Database
GET /api/1.0.0/db
Unshare
DELETE /api/1.0.0/share unshare.md
Unfollow
DELETE /api/1.0.0/follow unfollow.md
Deregister
DELETE /api/1.0.0/register deregister.md

NOTE

  • Installation in Linux machines can fail for the following reasons.
    • If you are in a corporate network that blocks Google DNS Servers, the ideam install command fails.

      To fix it, add your corporate DNS servers in DOCKER_OPTS in /etc/default/docker. (for SysV machines)

      DOCKER_OPTS="--dns 208.67.222.222 --dns 208.67.220.220"

      If this fails to set the DNS properly, try updating /etc/docker/daemon.json with the following (for systemd machines)

      { "dns": ["208.67.222.222", "208.67.220.220"] }

  • IDEAM has been tested on MacOS as well.