Draft: docs: add energy gateway
Closes eclipse/oniro-core/docs#40
Signed-off-by: Grzegorz Gwóźdź grzegorz.gwozdz@huawei.com
CC: @kristis
Merge request reports
Activity
Please call the file energy_gateway instead of gateway_bp.
For all git commit subject line we normally have a prefix for the file or area the commit changes something in e.g.
energy_gateway.rst: Initial version of Blueprint documentation
This prefix helps people when reading the logs later on.
- gateway_bp.rst 0 → 100644
46 (PV, electric vehicles, heat pumps, HVAC, appliances, smart plugs, etc.). 47 To collect this data Oniro will be extended to support the Modbus RTU and 48 TCP protocols as well as the upcoming Matter standard. 49 - Energy Management rule-set based on collect local data, PV energy forecast 50 and grid energy pricing. 51 52 Building and flashing 53 ********************* 54 Building this blueprint for the Rapsberry Pi 4 is similar to 55 `building and flashing a base Linux image <https://docs.oniroproject.org/en/latest/oniro/hardware-support/boards/raspberrypi4.html>`_, 56 with the addition of two extra layers. 57 58 Linux image 59 ----------- 60 61 1. Follow the `blueprint instructions <https://docs.oniroproject.org/projects/blueprints/en/latest/workspace.html#workspace>`_ @pidge here we will need your thoughts on the workspace setup. Jasmine blueprints added the extra layers to the normal Oniro build. But now with the submodules setup we have a different root from where layers are coming in. I would imagine that when the generic blueprint demo catches up on that we could remove a few steps here.
So, this part of the docs needs to be rewritten as it's out of date for what is currently in main.
it's more like:
- set up an oniroproject workspace.
- git clone --recursive your blueprint into CHECKOUTDIR
- add the layers in that blueprint repo
- TEMPLATECONF=../oniro/flavours/linux . ./oe-core/oe-init-build-env build-oniro-linux
- DISTRO=oniro-linux-blueprint-vending-machine MACHINE=qemux86 bitbake blueprint-vending-machine-image
We have a bit of a chicken and egg problem here as putting this here as a link to documentation that isn't even published yet for a release that hasn't been released yet is a bit of a problem (which honestly, i've given some thought to but haven't come up with anything elegent.
@pidge so we should remove the
Raspberry Pibuild and replace it with build forqemux86?changed this line in version 3 of the diff
No, please keep it as Pi4. This has not been tested with qemu. It was just an example from @pidge
@pidge I am a bit confused about the steps you outlined above. Why do we need to setup a oniroproject workspace first? IIRC the idea was to only have one git clone with all the layers as submodules. No extra workspace setup needed. For the energy gateway BP I have blueprints core and meta-homeassistant as git submodules already. Should I go and add oniro as well or how to you envision this to be handled?
requested review from @pidge
added 9 commits
-
53baf5a9...2dab5e4e - 8 commits from branch
eclipse/oniro-blueprints/oniro-blueprints-docs:main - d86f63cf - Add energy gateway docs
-
53baf5a9...2dab5e4e - 8 commits from branch
added 5 commits
-
d86f63cf...e7502869 - 4 commits from branch
eclipse/oniro-blueprints/oniro-blueprints-docs:main - dfaff362 - Add energy gateway docs
-
d86f63cf...e7502869 - 4 commits from branch
