Bluetooth: Mesh: Generic Level models

Adds the Generic Level Client and Generic Level Server models.

Signed-off-by: Trond Einar Snekvik <[email protected]>

Author: trond-snekvik

include/bluetooth/mesh/gen_lvl.h

@@ -0,0 +1,118 @@
+/*
+ * Copyright (c) 2019 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-BSD-5-Clause-Nordic
+ */
+
+/**
+ * @file
+ * @defgroup bt_mesh_lvl Bluetooth Mesh Generic Level models
+ * @{
+ * @brief Common API for the Bluetooth Mesh Generic Level models.
+ */
+#ifndef BT_MESH_GEN_LVL_H__
+#define BT_MESH_GEN_LVL_H__
+
+#include <bluetooth/mesh.h>
+#include <bluetooth/mesh/model_types.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** @cond INTERNAL_HIDDEN */
+#define BT_MESH_LVL_OP_GET BT_MESH_MODEL_OP_2(0x82, 0x05)
+#define BT_MESH_LVL_OP_SET BT_MESH_MODEL_OP_2(0x82, 0x06)
+#define BT_MESH_LVL_OP_SET_UNACK BT_MESH_MODEL_OP_2(0x82, 0x07)
+#define BT_MESH_LVL_OP_STATUS BT_MESH_MODEL_OP_2(0x82, 0x08)
+#define BT_MESH_LVL_OP_DELTA_SET BT_MESH_MODEL_OP_2(0x82, 0x09)
+#define BT_MESH_LVL_OP_DELTA_SET_UNACK BT_MESH_MODEL_OP_2(0x82, 0x0A)
+#define BT_MESH_LVL_OP_MOVE_SET BT_MESH_MODEL_OP_2(0x82, 0x0B)
+#define BT_MESH_LVL_OP_MOVE_SET_UNACK BT_MESH_MODEL_OP_2(0x82, 0x0C)
+
+#define BT_MESH_LVL_MSG_LEN_GET 0
+#define BT_MESH_LVL_MSG_MINLEN_SET 3
+#define BT_MESH_LVL_MSG_MAXLEN_SET 5
+#define BT_MESH_LVL_MSG_MINLEN_STATUS 2
+#define BT_MESH_LVL_MSG_MAXLEN_STATUS 5
+#define BT_MESH_LVL_MSG_MINLEN_DELTA_SET 5
+#define BT_MESH_LVL_MSG_MAXLEN_DELTA_SET 7
+#define BT_MESH_LVL_MSG_MINLEN_MOVE_SET 3
+#define BT_MESH_LVL_MSG_MAXLEN_MOVE_SET 5
+/** @endcond */
+
+/** Generic Level minimum value. */
+#define BT_MESH_LVL_MIN INT16_MIN
+/** Generic Level maximum value. */
+#define BT_MESH_LVL_MAX INT16_MAX
+
+/** Generic Level set message parameters.  */
+struct bt_mesh_lvl_set {
+	/** New level. */
+	s16_t lvl;
+	/** Whether this is a new action. */
+	bool new_transaction;
+	/**
+	 * Transition time parameters for the state change. Setting the
+	 * transition to NULL makes the server use its default transition time
+	 * parameters.
+	 */
+	const struct bt_mesh_model_transition *transition;
+};
+
+/** Generic Level delta set message parameters.  */
+struct bt_mesh_lvl_delta_set {
+	/** Translation from original value. */
+	s32_t delta;
+	/**
+	 * Whether this is a new transaction. If true, the delta should be
+	 * relative to the current value. If false, the delta should be
+	 * relative to the original value in the previous delta_set command.
+	 */
+	bool new_transaction;
+	/**
+	 * Transition time parameters for the state change. Setting the
+	 * transition to NULL makes the server use its default transition time
+	 * parameters.
+	 */
+	const struct bt_mesh_model_transition *transition;
+};
+
+/** Generic Level move set message parameters. */
+struct bt_mesh_lvl_move_set {
+	/** Translation to make for every transition step. */
+	s16_t delta;
+	/** Whether this is a new action. */
+	bool new_transaction;
+	/**
+	 * Transition parameters. @c delay indicates time until the move
+	 * should start, @c transition indicates the amount of time each
+	 * @c delta step should take. Setting the transition to NULL makes the
+	 * server use its default transition time parameters.
+	 */
+	const struct bt_mesh_model_transition *transition;
+};
+
+/** Generic Level status message parameters.  */
+struct bt_mesh_lvl_status {
+	/** Current level value. */
+	s16_t current;
+	/**
+	 * Target value for the ongoing transition. If there's no ongoing
+	 * transition, @c target should match @c value.
+	 */
+	s16_t target;
+	/**
+	 * Time remaining of the ongoing transition, or @ref K_FOREVER.
+	 * If there's no ongoing transition, @c remaining_time is 0.
+	 */
+	s32_t remaining_time;
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* BT_MESH_GEN_LVL_H__ */
+
+/** @} */

include/bluetooth/mesh/gen_lvl.rst

@@ -0,0 +1,96 @@
+.. _bt_mesh_lvl_readme:
+
+Generic Level models
+####################
+
+The Generic Level models allows remote control of integer states on a mesh
+device.
+
+There are two Generic Level models:
+
+- :ref:`bt_mesh_lvl_srv_readme`
+- :ref:`bt_mesh_lvl_cli_readme`
+
+.. _bt_mesh_lvl_srv_readme:
+
+Generic Level Server
+====================
+
+The Generic Level Server model owns a single Generic Level state.
+
+States
+*******
+
+**Generic Level**: ``s16_t``
+
+The user is expected to hold the state memory and provide access to the state
+through the :cpp:type:`bt_mesh_lvl_srv_handlers` handler structure.
+
+Changes to the Generic Level state may include transition parameters. While
+transitioning to a new level state, any requests to read out the current level
+should report the actual current level in the transition, as well as the
+terminal level and remaining time in milliseconds, including delay.
+
+If the transition includes a delay, the state shall remain unchanged until the
+delay expires.
+
+Extended models
+****************
+
+None.
+
+Persistent storage
+*******************
+
+None.
+
+API documentation
+******************
+
+| Header file: :file:`include/bluetooth/mesh/gen_lvl_srv.h`
+| Source file: :file:`subsys/bluetooth/mesh/gen_lvl_srv.c`
+
+.. doxygengroup:: bt_mesh_lvl_srv
+   :project: nrf
+   :members:
+
+----
+
+.. _bt_mesh_lvl_cli_readme:
+
+Generic Level Client
+====================
+
+The Generic Level Client model remotely controls the state of a Generic Level
+Server model.
+
+Extended models
+****************
+
+None.
+
+Persistent storage
+*******************
+
+None.
+
+API documentation
+******************
+
+| Header file: :file:`include/bluetooth/mesh/gen_lvl_cli.h`
+| Source file: :file:`subsys/bluetooth/mesh/gen_lvl_cli.c`
+
+.. doxygengroup:: bt_mesh_lvl_cli
+   :project: nrf
+   :members:
+
+----
+
+Common types
+=============
+
+| Header file: :file:`include/bluetooth/mesh/gen_lvl.h`
+
+.. doxygengroup:: bt_mesh_lvl
+   :project: nrf
+   :members: