This project allows you to mock a service with similar behavior as Einabit API so you can connect your project and quickly develop solutions. Or for just simply try our stuff.

You need to have docker installed in your computer and internet access in order to pull the public image

• Create a config file following the documentation
• Run the following command to execute the service using the public image from Dockerhub Repo:

docker run --rm -d -e CONFIG="$(cat config.yml)" -p 1337:1337 --name einabit einabit/sandbox

Connect to it using any client:

• Nodejs SDK
• Java SDK
• Python SDK

When using production environment, meaning real Einabit API, you will be provided with an encryption key since the API service will only answer to encrypted messages or queries.

If you want to try out this behavior you can provide a key as an environment variable PASSPHRASE to the sandbox.

This is optional when using the sandbox. The sandbox service will not try to decrypt messages if PASSPHRASE is not provided. Bare it in mind.

docker run --rm -d -e PASSPHRASE="<32 bit hex string>" -e CONFIG="$(cat config.yml)" -p 1337:1337 --name einabit einabit/sandbox

If you have node installed in your machine you can generate a random key using this command: node -p 'require("crypto").randomBytes(16).toString("hex")'

1. Simple temperature mock, the variable will increase or decrease by 1 each 400 ms

temp1:
  value:
    min: 0
    max: 100
    step: 1
  interval:
    ms: 400
    skip: 0

2. Simple photocell mock, the variable will change from 0 to 1 and vice versa every 2000 ms with a 20% skipping rate

vis1:
  value:
    min: 0
    max: 1
    step: 1
  interval:
    ms: 2000
    skip: .2

3. carriage sensor that will randomly increase or decrease by 2 from 20 to 40 every 1200 ms with a 50% skipping rate

crg1:
  value:
    min: 20
    max: 40
    step: 2
  interval:
    ms: 1200
    skip: .5

yml file must contain at least one variable

Since our services have to provide real time information we rely on sockets to do this. However it is pretty straight forward process with SDKs above referenced.

SDKs above referenced do that but they provide a layer of abstraction so you don't have to mess with primitives of asynchronous communication. In case you want to learn how the process works or just because you're thinking on developing another SDK for a different language here are the telnet instructions that describe the available API.

In Deep Guide