nRF5 SDK for Mesh v3.2.0  08c60f6
generic_onoff_common.h
1 /* Copyright (c) 2010 - 2019, Nordic Semiconductor ASA
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification,
5  * are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form, except as embedded into a Nordic
11  * Semiconductor ASA integrated circuit in a product or a software update for
12  * such product, must reproduce the above copyright notice, this list of
13  * conditions and the following disclaimer in the documentation and/or other
14  * materials provided with the distribution.
15  *
16  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
17  * contributors may be used to endorse or promote products derived from this
18  * software without specific prior written permission.
19  *
20  * 4. This software, with or without modification, must only be used with a
21  * Nordic Semiconductor ASA integrated circuit.
22  *
23  * 5. Any software provided in binary form under this license must not be reverse
24  * engineered, decompiled, modified and/or disassembled.
25  *
26  * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
27  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
29  * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
30  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
32  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
35  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef GENERIC_ONOFF_COMMON_H__
39 #define GENERIC_ONOFF_COMMON_H__
40 
41 #include <stdint.h>
42 #include "model_common.h"
43 
56 #define GENERIC_ONOFF_COMPANY_ID 0xFFFF
57 
59 #define GENERIC_ONOFF_MAX (0x01)
60 
67 typedef struct
68 {
69  bool on_off;
70  uint8_t tid;
72 
74 typedef struct
75 {
76  bool on_off;
77  uint8_t tid;
79 
81 typedef struct
82 {
83  uint8_t present_on_off;
84  uint8_t target_on_off;
85  uint32_t remaining_time_ms;
87 
89 #endif /* GENERIC_ONOFF_COMMON_H__ */
generic_onoff_state_t::tid
uint8_t tid
Transaction ID.
Definition: generic_onoff_common.h:70
generic_onoff_status_params_t
Parameters for the Generic OnOff Status message.
Definition: generic_onoff_common.h:81
generic_onoff_status_params_t::remaining_time_ms
uint32_t remaining_time_ms
Remaining time value in milliseconds.
Definition: generic_onoff_common.h:85
generic_onoff_set_params_t::on_off
bool on_off
State to set.
Definition: generic_onoff_common.h:76
generic_onoff_set_params_t::tid
uint8_t tid
Transaction ID.
Definition: generic_onoff_common.h:77
generic_onoff_state_t
Unpacked message structure typedefs are used for API interfaces and for implementing model code.
Definition: generic_onoff_common.h:67
generic_onoff_status_params_t::present_on_off
uint8_t present_on_off
The present value of the Generic OnOff state.
Definition: generic_onoff_common.h:83
generic_onoff_state_t::on_off
bool on_off
State to set.
Definition: generic_onoff_common.h:69
generic_onoff_status_params_t::target_on_off
uint8_t target_on_off
The target value of the Generic OnOff state (optional)
Definition: generic_onoff_common.h:84
generic_onoff_set_params_t
Mandatory parameters for the Generic OnOff Set message.
Definition: generic_onoff_common.h:74