nRF5 SDK for Mesh V5.00src

# Light CTL example @tag52840and52833and52832 @tag52810and52820nosupport This example demonstrates how you can use Bluetooth mesh messages and events from the [Light CTL models](@ref LIGHT_CTL_MODELS) API to implement a tunable white light. The example is composed of three minor examples that use the Light CTL Client and Light CTL Server models: - Light CTL client model example - Light CTL server model example - Light CTL server with Light LC server models' example For more information about the Light CTL Client and Server models, see the @link_ModelOverview from Bluetooth SIG. For provisioning purposes, the example requires either [the provisioner example](@ref md_examples_provisioner_README) or the @link_nrf_mesh_app. All the minor examples have the provisionee role in the network. They support provisioning over Advertising bearer (PB-ADV) and GATT bearer (PB-GATT) and also support Bluetooth mesh Proxy Service (Server). Read more about the Proxy feature in @ref md_doc_user_guide_modules_provisioning_gatt_proxy. **Table of contents** - [Light CTL client model example](@ref light_ctl_example_light_ctl_client) - [Light CTL server model example](@ref light_ctl_example_light_ctl_server) - [Scene model](@ref light_ctl_example_light_ctl_server_scene_model) - [Light CTL Server and Light LC Server models' example](@ref light_ctl_example_light_ctl_lc_server) - [Light CTL models](@ref light_ctl_example_light_ctl_model) - [Hardware requirements](@ref light_ctl_example_hw_requirements) - [Software requirements](@ref light_ctl_example_sw_requirements) - [Setup](@ref light_ctl_example_setup) - [LED and button assignments](@ref light_ctl_example_setup_leds_buttons) - [Scene model integration](@ref light_ctl_example_setup_scene_model) - [Testing the example](@ref light_ctl_example_testing) - [Evaluating using the static provisioner](@ref light_ctl_example_testing_dk) - [Evaluating using the nRF Mesh mobile app](@ref light_ctl_example_testing_app) - [Interacting with the boards](@ref light_ctl_example_testing_interacting) - [Controlling CTL lightness, CTL temperature, and CTL delta UV values](@ref light_ctl_example_controlling_lightness_value) - [Changing behavior on power-up](@ref light_ctl_example_changing_behavior_on_powerup) - [Restricting the range of the CTL temperature value](@ref light_ctl_example_changing_temperature_range) - [Restricting the range of the CTL lightness value](@ref light_ctl_example_changing_lightness_range) - [Other factory default configuration](@ref light_ctl_example_other_factory_default_configuration) --- ## Light CTL client model example @anchor light_ctl_example_light_ctl_client The light CTL client model example has a provisionee role in the network. It implements two instances of the [Light CTL Client model](@ref LIGHT_CTL_CLIENT). These instances are used to control the brightness of the LEDs on the servers, the range of supported CTL temperature levels, and the CTL lightness, temperature, and delta UV values after the servers' boot-up. --- ## Light CTL server model example @anchor light_ctl_example_light_ctl_server The light CTL server model example has a provisionee role in the network. It implements one instance of the [Light CTL Setup Server model](@ref LIGHT_CTL_SETUP_SERVER), and [Light Lightness Setup Server model] (@ref LIGHT_LIGHTNESS_SETUP_SERVER). These instances in-turn initialize other necessary models. The Light Lightness Server model is used by Light CTL Server to control the lightness value. The Light CTL Server model is used to receive the lightness, temperature and delta UV values. The received values are used to demonstrate a tunable white light by means of the two LEDs on the DK board. The LED 1 represents a warm light, while LED 2 represents a cool white light. These two LEDs are controlled with different PWM duty cycles corresponding to the given color temperature. Also, the overall light output is scaled by the given lightness level to achieve dimming. The photometrically accurate implementation of the tunable white light is out of scope of this example. The model instance uses the @link_APP_PWM library from the nRF5 SDK to control the brightness of the LEDs. To demonstrate a tunable white light, the lightness and the temperature values are converted to appropriate brightness level for each LED. These are then converted to the generic level values to map them to the PWM tick values for each LED.  ### Scene model @anchor light_ctl_example_light_ctl_server_scene_model The light CTL server model example also implements one instance of the [Scene Setup Server model](@ref SCENE_SETUP_SERVER). The Scene Setup Server instance can be used together with the [Scene Client](@ref SCENE_CLIENT), although both model instances are optional and [can be excluded](@ref light_ctl_example_setup_scene_model). The Scene Server model uses the Default Transition Time Server instance instantiated in the Light CTL Setup Server model instance. For the values stored and recalled by the Scene model, see the @tagMeshMdlSp, Table 6.123. For more information on how to use the [Scene models](@ref SCENE_MODELS), see the [scene example](@ref md_examples_scene_README). --- ## Light CTL server and light LC server models' example @anchor light_ctl_example_light_ctl_lc_server The light CTL server and light LC server models' example has a provisionee role in the network. It implements one instance of the [Light CTL Setup Server model](@ref LIGHT_CTL_SETUP_SERVER), a [Light LC Setup Server model](@ref LIGHT_LC_SETUP_SERVER), and other necessary models in such a way that light LC server is able to control the lightness output. This shows how a tunable white light can be implemented to have a feature of automated lighting control. The Light CTL Server model instance is used to receive the CTL lightness, temperature, and delta UV values and change the brightness and color temperature of the lights. The LC model adds the capability for automated lightness control handled by the LC FSM and PI regulator, based on predefined settings and sensor inputs. Refer to [light LC server model example](@ref light_lc_server_example_testing_interacting) for information about how a light LC server works. The hardware interface of this example is similar to the light CTL server model example. --- ## Light CTL models @anchor light_ctl_example_light_ctl_model The Light CTL Client model is used for manipulating the following states associated with the peer Light CTL Server, Light CTL Setup Server, and Light CTL Temperature Server models: - Light CTL Lightness - Light CTL Temperature - Light CTL Delta UV - Light CTL Lightness, Temperature, and Delta UV Default - Light CTL Temperature Range @note The Light CTL Lightness is bound with Light Lightness Actual state. The received Light Lightness state value is represented in the form of Light CTL Lightness value as a result of this binding. More information about the Light CTL models can be found in the [Light CTL models documentation](@ref LIGHT_CTL_MODELS). --- ## Hardware requirements @anchor light_ctl_example_hw_requirements You need at least two compatible development kits for this example: - One compatible development kit for the client. - One or more compatible development kits for the servers. On the server boards, you can either run the light CTL server model example or the light CTL server with light LC server models' example, or both of them. If you choose the light CTL server with light LC server models' example, you also need at least one of the following: - One compatible development kit for emulating the occupancy sensor. - One compatible development kit for the [light switch client](@ref light_switch_demo_client). See [light LC server model example testing](@ref light_lc_server_example_testing) section for more information about how the light