https://github.com/blackode/atria_power
A simple proof-of-concept application which can store sensor data (eg. temperature sensor data)
https://github.com/blackode/atria_power
Last synced: 11 months ago
JSON representation
A simple proof-of-concept application which can store sensor data (eg. temperature sensor data)
- Host: GitHub
- URL: https://github.com/blackode/atria_power
- Owner: blackode
- Created: 2020-09-24T18:39:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-29T07:53:43.000Z (over 5 years ago)
- Last Synced: 2025-03-04T16:46:29.800Z (over 1 year ago)
- Language: Elixir
- Size: 309 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Welcome AtriaPower
## Project Highlighted Module
### AtriaPower.TempServer
This module simulates a sensor sending data using `GenServer` named as
`AtriaPower.TempServer`.
It will start as soon as our phoenix app runs but it will be in a *disabled*
state by default. An option is provided to enable this sensor.
### Note
After enabled, It keeps posting data for every minute. Wait for couple of minutes to reflect the data into DataBase.
## Development Technologies
At the moment of developing this project, I used the following versions of
Elixir and Erlang.
```elixir
iex> mix hex.info
Hex: 0.20.5
Elixir: 1.10.4
OTP: 23.0.3
Built with: Elixir 1.10.0 and OTP 21.3
```
## Starting Application
To start the Phoenix server:
* Install dependencies with `mix deps.get`
* Create and migrate your database with `mix ecto.setup`
* Install Node.js dependencies with `npm install` inside the `assets` directory
* Start Phoenix endpoint with `mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
## API EndPoints
* GET `/` Basic index route to alll available routes
* GET `/sensors/enable/:sensor_type` To enable specific sensor to send data ex.. `/sensors/enable/temparature`
* GET `/sensors/disable/:sensor_type` To disable specific sensor from sending data ex.. `/sensors/disable/temparature`
* GET `/data_packets` To list out all packets in the given date time range, default it uses present day
* POST `/data_packets/search` A post request for filtering the datapackets based date and time including sensor
* POST `/data_packets` Used to send the packet from server to db - A storing purpose of a packet.
## Database Setup
For quick setup I used the default values of *Postgres* database.
The following configuration is used
```elixir
username: "postgres",
password: "postgres",
database: "atria_power_dev",
hostname: "localhost",
```
Make sure to run a postgres server with above credentials. If not, then update
the config inside `config/dev.exs` under `config :atria_power, AtriaPower.Repo`
A data migration file added to create a table named `data_packets`.
This table comprises the following schema
```elixir
schema "data_packets" do
field :reading, :float
field :sensor_type, :string
field :timestamp, :integer #bigint
timestamps()
end
```
## External Modules used
### [Timex](https://github.com/bitwalker/timex/)
Used for flexible timestamp values for conveting to datetime and to develop query filters based on.
### [Chart.Js](https://www.chartjs.org/)
Npm module for developing a LineChart.
## Project Challenges
* Search Implementation (filters by datetime range)
* Sensor Server callbacks handling(It went on many iterations by updateing both client and server api handling funtions on requirement)
* Developing Charts (Making use of NodeModules inside the Phoenix)
## TIL
Learned how to use `ChartJs` node package inside the Phoenix for developing charts over dynamic data.
Understanding `Webpack.config.js` file in a deeper way like chaning paths adding entry points for new js files compilation and more.
## Overall Project Experience
I felt it is a well framed to test core concepts of Elixir as project made me to code in all the core concepts of Elixir like `GenServers`, `Supervisors`, `Enumaration`, `Data Comprehension` and moreover it is outstanding on its own way covering the model, view, and Controller architecture concepts.
Enjoyed in coding a `Genserver` that simulates sensor data to preserve and implementation of Data Charts using `Chart.Js` node library is a great experience.
Thank You :)
Best Regards,
Ankanna