Skip to content

Latest commit

 

History

History
96 lines (63 loc) · 4.18 KB

README.md

File metadata and controls

96 lines (63 loc) · 4.18 KB
Raw

Project logo

Status Docker Image CI GitHub Issues GitHub Pull Requests License


Radlet Dock

The Radlet ecosystem was created keeping speed and flexibility in mind and thus making edge computing a little more easier for people who wish to tinker. The existing IOT solutions are either proprietary or are too tightly coupled for a regular user to tinker with. We bring the speed of coupled system and the flexibility of a decoupled system with the perfectly balanced IOT ecosystem - Radlet. The ecosystem consists of three primary components out of which this repository hold the code for Radlet-Dock.

Table of Contents :octocat:

1. Structure ❄️

The internal structure of our dock is according to the block diagram that follows. This is done so that users can tinker with the system easily and swap in and our things according to their needs. Project Plan

2. Getting Started 🍀

To make things easier for everyone we have made use of docker for build testing and deployment. This takes away most of the problems that you might face during project setup which includes library installation, environment variable setup etc. For the upcoming steps to work, you need the following applications installed on your OS.

2.a Prerequisites

  • Docker
  • Docker-Compose
  • Git

2.b Build

The build step makes use of docker that comes packed with all the necessary libraries that we are using. Under the hood, it pulls the humbled/radlet_dock.env image from docker hub and attempts to create a new radlet_dock.dev image. The following command is used not only for image creation but also for build testing. If the image creation exits with a non-zero code, then the build was not successful.

Run the following command from project root:

./package.sh -b

2.c Manual test / Run

After a radlet_dock.dev image has been created we can manually test the dock by running it. For it, we will open an interactive shell in the docker container and run the dock binary.

Run the following command from project root:

./package.sh -mt
./bin/radlet_dock

3. Deployment 🔥

For the purpose of deployment, we can straight away use the docker hub image. The deployment is kept upto date by our team.
Docker

To run the deployment build, simply run the following command:

./package.sh -d

4. Usage 📕

Once the deployment build has been started in a container the dock is ready to accept IOT devices and user requests for device orchestration. You can use our phone app Radlet-Composer and ESP8266 compatible firmware Radlet-Plankton to test out an IOT device in the Radlet ecosystem.

5. Built Using 💅

Check project wiki to know more...

6. Authors 🔨