nRF5 SDK for Mesh v5.0.0
generic_onoff_messages.h
1 /* Copyright (c) 2010 - 2020, 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_MESSAGES_H__
39 #define GENERIC_ONOFF_MESSAGES_H__
40 
41 #include <stdint.h>
42 
52 #define GENERIC_ONOFF_SET_MINLEN 2
53 
54 #define GENERIC_ONOFF_SET_MAXLEN 4
55 
57 #define GENERIC_ONOFF_STATUS_MINLEN 1
58 
59 #define GENERIC_ONOFF_STATUS_MAXLEN 3
60 
62 typedef enum
63 {
64  GENERIC_ONOFF_OPCODE_SET = 0x8202,
65  GENERIC_ONOFF_OPCODE_SET_UNACKNOWLEDGED = 0x8203,
66  GENERIC_ONOFF_OPCODE_GET = 0x8201,
67  GENERIC_ONOFF_OPCODE_STATUS = 0x8204
68 } generic_onoff_opcode_t;
69 
73 typedef struct __attribute((packed))
74 {
75  uint8_t on_off;
76  uint8_t tid;
77  uint8_t transition_time;
78  uint8_t delay;
80 
82 typedef struct __attribute((packed))
83 {
84  uint8_t present_on_off;
85  uint8_t target_on_off;
86  uint8_t remaining_time;
88 
90 #endif /* GENERIC_ONOFF_MESSAGES_H__ */
uint8_t tid
Transaction number for application.
Packed message structure typedefs are used for packing and unpacking byte stream. ...
uint8_t remaining_time
Encoded remaining time.
uint8_t transition_time
Encoded transition time value.
uint8_t delay
Encoded message execution delay in 5 millisecond steps.
uint8_t target_on_off
The target value of the Generic OnOff state (optional)
uint8_t present_on_off
The present value of the Generic OnOff state.
Message format for the generic_onoff Status message.

Documentation feedback | Developer Zone | Subscribe | Updated