/corinthian

An IUDX compliant IoT middleware for smart cities

Primary LanguageHTMLOtherNOASSERTION

Corinthian

travis codacy license

An IUDX compliant IoT middleware for smart cities

Documentation: https://iudx.readthedocs.io

Quickstart

  1. Clone the repository:

    git clone https://github.com/rbccps-iisc/corinthian
    cd corinthian
    git submodule init
    git submodule update
    
  2. Install the required dependencies (Host OS must be Ubuntu):

    ./test-suite/require.sh
    
  3. If the host OS is not Ubuntu then install the following dependencies manually

    • docker
    • docker-compose

    Also install the following dependencies if the tests need to be run

    • requests
    • urllib3
    • pika
  4. Start the installation:

    ./docker/install
    
  5. Test the middleware using:

    ./test-suite/test functional --random
    

Restricting admin APIs

By default the admin related APIs are allowed from any host. To restrict access of admin APIs through localhost only: unset the "ALLOW_ADMIN_APIS_FROM_OTHER_HOSTS" environment variable (in the docker/.env file).

Use-case diagrams

https://raw.githubusercontent.com/rbccps-iisc/corinthian/master/DOCS/usecase-diagrams/uc.svg?sanitize=true

Sequence diagrams

  • Registration

https://raw.githubusercontent.com/rbccps-iisc/corinthian/master/DOCS/sequence-diagrams/register.svg?sanitize=true

  • Share/Follow

https://raw.githubusercontent.com/rbccps-iisc/corinthian/master/DOCS/sequence-diagrams/follow-share-publish-subscribe.svg?sanitize=true

API

All APIs are based on the following format: /<caller of the API>/<action>

  • /admin/register-owner

https://raw.githubusercontent.com/rbccps-iisc/corinthian/master/DOCS/api/register-owner.svg?sanitize=true

  • /owner/register-entity

https://raw.githubusercontent.com/rbccps-iisc/corinthian/master/DOCS/api/register-entity.svg?sanitize=true

  • /entity/publish

https://raw.githubusercontent.com/rbccps-iisc/corinthian/master/DOCS/api/publish.svg?sanitize=true

  • /entity/subscribe

https://raw.githubusercontent.com/rbccps-iisc/corinthian/master/DOCS/api/subscribe.svg?sanitize=true

  • /owner/follow

https://raw.githubusercontent.com/rbccps-iisc/corinthian/master/DOCS/api/follow.svg?sanitize=true

  • /owner/follow-status

https://raw.githubusercontent.com/rbccps-iisc/corinthian/master/DOCS/api/follow-status.svg?sanitize=true