/developer_joyofenergy_meter_c

Primary LanguageC

Welcome to PowerDale

PowerDale is a small town with around 100 residents. Most houses have a smart meter installed that can save and send information about how much power a house is drawing/using.

There are three major providers of energy in town that charge different amounts for the power they supply.

  • Dr Evil's Dark Energy
  • The Green Eco
  • Power for Everyone

Introducing JOI Energy

JOI Energy is a new start-up in the energy industry. Rather than selling energy they want to differentiate themselves from the market by recording their customers' energy usage from their smart meters and recommending the best supplier to meet their needs.

You have been placed into their development team, whose current goal is to produce an API which their customers and smart meters will interact with.

Unfortunately, two members of the team are on annual leave, and another one has called in sick! You are left with another ThoughtWorker to progress with the current user stories on the story wall. This is your chance to make an impact on the business, improve the code base and deliver value.

Story Wall

At JOI energy the development team use a story wall or Kanban board to keep track of features or "stories" as they are worked on.

The wall you will be working from today has 7 columns:

  • Backlog
  • Ready for Dev
  • In Dev
  • Ready for Testing
  • In Testing
  • Ready for sign off
  • Done

Examples can be found here https://leankit.com/learn/kanban/kanban-board/

Requirements

The project requires Cmake 3.21 or higher.

The project makes use of Conan.

Useful Conan commands

The project makes use of Conan to help you out carrying some common tasks such as building the project or running it.

Build the project

Compiles the project, runs the test and then creates an executable file.

$ mkdir build && cd build
$ conan install .. --build missing
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_paths.cmake
$ cmake --build . -j 8

Run the tests

Technically, this app is a firmware, which is unable to be run on PC, but you can run test.

There are two types of tests, the unit tests and the functional tests. These can be executed as follows.

  • Run functional tests only

    $ ctest .

API

Smart meter accepts API calls from kind of endpoint (could be UART, IIC, SPI etc...), request and respond datagram follows format:

| byte 1 | byte 2 | byte 3 | byte 4 | byte 5 | byte 6 | byte 7 | byte 8 |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|               length              |              command              |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|                                payload...                             |

Get Reading

Reading command

| byte 1 | byte 2 | byte 3 | byte 4 | byte 5 | byte 6 | byte 7 | byte 8 |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ |
|               length              |              command              |
| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ |

Command is: MESSAGE_READING_READ

Response comes with the same message head, but with payload which is defined by struct reading_message_response in meter/adapter/protocol/reading.h.