Elixir phoenix based microservice application to control and communicate with microcontrollers.
This is a microservice which uses websockets to communicate with ESP8266/ESP32 based microcontrollers to read data, controls servos, etc.
The intent of this application is to have 100% test coverage so TDD is preffered.
The preffered way is to use asdf to have full control of the system but devcontainers are also a valid way of running the application in a scenario where an usual development machine can not be accessed.
The current preffered way to setup the environment is to use asdf.
To start with the installation please follow the asdf installation instructions.
After that the required plugins need to be added:
asdf plugin add elixir
asdf plugin add erlang
asdf plugin add vars https://github.com/excid3/asdf-varsAfter installing the required plugins go to the following file: ~/.asdf/lib/commands/command-exec.bash and find the line:
with_shim_executable "$shim_name" exec_shim || exit $?After that, add a new line before it:
eval "$($ASDF_DIR/bin/asdf vars)"And then the final result should look like:
eval "$($ASDF_DIR/bin/asdf vars)"
with_shim_executable "$shim_name" exec_shim || exit $?Once that step is complete, create a file named .asdf-vars, this file will contain all of the environment varulables required by the project.
After that step, the final step is to install Elixir and Erlang:
asdf install
Currently the settings for production are the same as for development.
If the application is ran with asdf, then either podman or docker need to be installed. In case podman and podman-compose are installed, you would need to run podman-compose up -d.
| Variable name | Type | Example | Definition | Optional |
|---|---|---|---|---|
| MICROCONTROLLER_AUTH_SERVER | String | http://localhost:5000 | URL of the auth server. | No |
To start your Phoenix server:
- Run
mix setupto install and setup dependencies - Start Phoenix endpoint with
mix phx.serveror inside IEx withiex -S mix phx.server
Now you can visit localhost:4000 from your browser.
Ready to run in production? Please check our deployment guides.
General documentation for client. Because of the sheer amount of connections/call, specific files are created for each each scenario. Potentially in a CI/CD environment the documentation for the API will be generated and hosted in a better way.
- Official website: https://www.phoenixframework.org/
- Guides: https://hexdocs.pm/phoenix/overview.html
- Docs: https://hexdocs.pm/phoenix
- Forum: https://elixirforum.com/c/phoenix-forum
- Source: https://github.com/phoenixframework/phoenix