Apply many fixes re formatting of the document:
- Remove unnecessary quotation marks,
- Use ``backticks`` for inline code formatting,
- Fix incorrect break of a long TEMPLATECONF=.. line,
- Remove unnecessary break of `wget ...` line,
- Add/remove some spaces,
- Use ``#`` for comments in shell commands,
- Make GPIO capitalization consistent.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>

Add a document describing how to assemble setup for the
Smart Panel blueprint, how to build images for Avenger96
and Nitorgens, how to flash them and configure Home Assistant.

Add images with HA UI configuration examples and photo of
the assembled setup.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>

ActsGlobalDateTimeTest test suite requires hos-global-i18n-lite
shared library.

Signed-off-by: Robert Drab <robert.drab@huawei.com>

ohos-global-i18n-lite is a shared library providing i18n functions
like formatting date/time strings.

Signed-off-by: Robert Drab <robert.drab@huawei.com>

* Install host-package command modified for formatting issue, fixes
  issue https://git.ostc-eu.org/OSTC/comms/www.ostc-eu.org/-/issues/76

.

Signed-off-by: Arul Kumaran <arulkumaran.devarajan@huawei.com>

Update revision to include commits from merge request
OSTC/OHOS/components/smart_home_blueprint_zephyr!14,
that changes BT DIS model name string by changing
the word Sensor to Devie.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>

The -led suffix is inconsistent with every other naming in the
project (i.e. env variable with MAC address, device class in
Home Assistant), so change it to -switch.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>

* Hardware supported boards modified to reference Supported Images.
* docs/index.rst modified to include Supported Images topic in toctree.

Signed-off-by: Arul Kumaran <arulkumaran.devarajan@huawei.com>

Update revision to include commits from merge request
OSTC/OHOS/components/smart_home_blueprint_zephyr!13,
that fixes a buffer overflow in BT DIS model name string.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>

Currently machines and flavours are defined in the meta-ohos repository
but their CI pipelines are defined in the manifest repository. Move the
definitions of the various build jobs here to be included from the
manifest repository internally.

This way the public interface is unchanged but patches such as the
recent Raspberry Pi 4 support can enable a new MACHINE configuration and
a new CI job all in one go, to the extent that in-progress CI will pick
it up.

Closes: https://git.ostc-eu.org/OSTC/OHOS/meta-ohos/-/issues/44


Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Stefan Schmidt authored 3 years ago and Andrei Gherzan committed 3 years ago

This change has been upstreamed and backported. With our latest sync to
the dunfell branch we no longer need this.

Signed-off-by: Stefan Schmidt <stefan.schmidt@huawei.com>

* All topics revised to reflect All scenarios OS instead of All scenario
  OS to maintain consistency, fixes issue#70

Signed-off-by: Arul Kumaran <arulkumaran.devarajan@huawei.com>

Andrei Gherzan authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

The new version includes commit(s) that rename various parts accordingly
to the change to All Scenarios OS.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Wojciech Zmuda authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Zbigniew Bodek authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

Use homeassistant-config-blueprint-dashboard
package to install configuration files in the dashboard
blueprint image.

Signed-off-by: Zbigniew Bodek <zbigniew.bodek@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Andrei Gherzan authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

Add recipe for creating HomeAssistant's configuration
for dashboard blueprint.
- Install default configuration files. Currently
  it's only configuration.yaml
- Apply changes in run-time based on build variables

Signed-off-by: Zbigniew Bodek <zbigniew.bodek@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Zbigniew Bodek authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

The plugin is used by Home Assistant in the Smart Home blueprint scenario
to communicate with IoT sensors and light switchd devices.

Instead of adding smart-home-homeassistant-plugin to installation
packages list, include it via RRECOMMENDS for HomeAssistant.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>
Signed-off-by: Zbigniew Bodek <zbigniew.bodek@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Wojciech Zmuda authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

The recipe installs Home Assistant custom component for communication
with IoT sensors and light switch devices running All ScenariOS firmware
for the Smart Home blueprint.

The recipe adds entries to HA configuration.yaml file. The entries are
generated with MAC addresses of the expected devices, that are part of
the blueprint setup. They are defined in the relevant blueprint config
file and can be overriden in local.conf.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Wojciech Zmuda authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

This recipe installs a Python library that can be used for
communication over BLE with IoT devices using AllScenariOS
Smart Home firmware.

It is used by Smart Panel Home Assistant plugin.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Andrei Gherzan authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

This inc file is useful so multiple recipes can synchronise on the same
path for the main Home Assistant configuration. For example, a recipe
bringing a custom Home Assistant configuration would use this as the
source of truth for the directory where this configuration needs to
reside. Home Assistant will use the same configuration path at
runtime.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Andrei Gherzan authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

This inc file is useful so multiple recipes can synchronise on the same
user configuration. For example, a recipe bringing a custom Home
Assistant configuration would use this to set the proper user ownership
of the configuration file.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Wojciech Zmuda authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

Multiple IoT devices in the Smart Home blueprint are to be
programmed with firmware built from the same sources. That
sources specify MAC address of the BLE interface of the device.
Multiple devices cannot work at once with the same MAC, so in
that case user should have possibility to specify the address
in build time.

Variable SMART_HOME_SWITCH_MAC can be provided to Bitbake.
If detected, its value is used as MAC address for devices
using zephyr-blueprint-smarthome-led image.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Wojciech Zmuda authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

Multiple IoT devices in the Smart Home blueprint are to be
programmed with firmware built from the same sources. That
sources specify MAC address of the BLE interface of the device.
Multiple devices cannot work at once with the same MAC, so in
that case user should have possibility to specify the address
in build time.

Variable SMART_HOME_SENSORS_MAC can be provided to Bitbake.
If detected, its value is used as MAC address for devices
using zephyr-blueprint-smarthome-sensors image.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Wojciech Zmuda authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

Multiple IoT devices in the Smart Home blueprint are to be
programmed with firmware built from the same sources. That
sources specify MAC address of the BLE interface of the device.
Multiple devices cannot work at once with the same MAC, so in
that case user should have possibility to specify the address
in build time.

Look for `MAC` variable - if set, use its value as MAC address,
substituting the default value in the source code of the firmware.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Wojciech Zmuda authored 3 years ago and Bernhard Rosenkränzer committed 3 years ago

Smart Panel blueprint sensor and switch devices MAC addrsses have to be:
 - configured on devices so they communicate over BLE from known addresses
   that do not collide,
 - configured in Home Assistant so it knows where to connect to.

Addresses can be overriden in local.conf of Linux build or in command line.

Signed-off-by: Wojciech Zmuda <wojciech.zmuda@huawei.com>
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

* New note added for Bitbake command disk space, fixes issue#79

Signed-off-by: Arul Kumaran <arulkumaran.devarajan@huawei.com>

* New sentence 'Once the image is built, you can run a Qemu X86-64 instance using the
  provided script wrapper as follows:' is added under Booting a Qemu
  X86-64 target with a OpenHarmony image, Fixes issue #77.

Signed-off-by: Arul Kumaran <arulkumaran.devarajan@huawei.com>

The correct from is "All Scenarios OS" as opposed to "All Scenario OS".
This change also replaces a reference to OHOS.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

This relies on the plantuml plugin/module so it also includes the
required extension and to simplify that, we switch to using a `conf.py`
file.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Acronym looks good in some places but in sentences the full name is more
readable.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

This bundles a rather large rename of all the recipes, descriptions and
comments, with the exception of repositories referenced from gitee or
other third party system (e.g. launchpad PPAs or COPR repositories).

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

External repositories for various distributions are left unchanged.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

The manifest repository now offers new hidden jobs, that make
customization and reuse easier. Those allow us to remove bulk of the
custom logic, again, reducing everything to mere configuration.

The build-docs and update-docs jobs are entirely replaced by .build-docs
and .aggregate-docs (name change without logic change).

Custom .build job is split into smaller changes to the .workspace and
.bitbake-workspace jobs. Lastly, the variable OHOS_CI_GIT_REPO_PATH
is no longer relative to sources/ but includes it explicitly.

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>

* 'pyOCD-flashtool -l' command syntax rectified as 'pyocd-flashtool -l',
 fixes issue#39

Signed-off-by: Arul Kumaran <arulkumaran.devarajan@huawei.com>

Due to a configuration bug in upstream, the build system outputs a
configuration warning similar to:

---------- CONFIG_SERIAL_OF_PLATFORM -----------------
Config: CONFIG_SERIAL_OF_PLATFORM
From:
[...]/kernel-source/.kernel-meta/configs/v5.10/standard/cfg/8250.cfg
Requested value:  CONFIG_SERIAL_OF_PLATFORM=y
Actual value:

Avoid this by disabling the specific config.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

When building with Python 3.9+ on the host, there are various ways the
build will fail. Fixes to address these issues are already in newer
version of the component so this only backports two related patches.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

To address the "demo" to "blueprint" rename, zephyr-demo-smarthome-base
repository was also renamed accordingly. Reflect this change in the
build recipe.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>