nRF5 SDK for Mesh v5.0.0
generic_level_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_LEVEL_MESSAGES_H__
39 #define GENERIC_LEVEL_MESSAGES_H__
40 
41 #include <stdint.h>
42 #include "generic_level_common.h"
52 #define GENERIC_LEVEL_SET_MINLEN 3
53 
54 #define GENERIC_LEVEL_SET_MAXLEN 5
55 
57 #define GENERIC_LEVEL_DELTA_SET_MINLEN 5
58 
59 #define GENERIC_LEVEL_DELTA_SET_MAXLEN 7
60 
62 #define GENERIC_LEVEL_MOVE_SET_MINLEN 3
63 
64 #define GENERIC_LEVEL_MOVE_SET_MAXLEN 5
65 
67 #define GENERIC_LEVEL_STATUS_MINLEN 2
68 
69 #define GENERIC_LEVEL_STATUS_MAXLEN 5
70 
71 
72 
74 typedef enum
75 {
76  GENERIC_LEVEL_OPCODE_GET = 0x8205,
77  GENERIC_LEVEL_OPCODE_SET = 0x8206,
78  GENERIC_LEVEL_OPCODE_SET_UNACKNOWLEDGED = 0x8207,
79  GENERIC_LEVEL_OPCODE_STATUS = 0x8208,
80  GENERIC_LEVEL_OPCODE_DELTA_SET = 0x8209,
81  GENERIC_LEVEL_OPCODE_DELTA_SET_UNACKNOWLEDGED = 0x820A,
82  GENERIC_LEVEL_OPCODE_MOVE_SET = 0x820B,
83  GENERIC_LEVEL_OPCODE_MOVE_SET_UNACKNOWLEDGED = 0x820C
84 } generic_level_opcode_t;
85 
89 typedef struct __attribute((packed))
90 {
91  int16_t level;
92  uint8_t tid;
93  uint8_t transition_time;
94  uint8_t delay;
96 
98 typedef struct __attribute((packed))
99 {
100  int32_t delta_level;
101  uint8_t tid;
102  uint8_t transition_time;
103  uint8_t delay;
105 
107 typedef struct __attribute((packed))
108 {
109  int16_t move_level;
110  uint8_t tid;
111  uint8_t transition_time;
112  uint8_t delay;
114 
116 typedef struct __attribute((packed))
117 {
118  int16_t present_level;
119  int16_t target_level;
120  uint8_t remaining_time;
122 
124 #endif /* GENERIC_LEVEL_MESSAGES_H__ */
uint8_t tid
Transaction number for application.
int16_t target_level
The target value of the Generic Level state (optional)
Packed message structure typedefs are used for packing and unpacking byte stream. ...
Message format for the generic_level Move Set message.
uint8_t transition_time
Encoded transition time value.
Message format for the generic_level Delta Set message.
uint8_t transition_time
Encoded transition time value.
uint8_t delay
Encoded message execution delay in 5 millisecond steps.
uint8_t transition_time
Encoded transition time value.
uint8_t remaining_time
Encoded remaining time.
uint8_t tid
Transaction number for application.
uint8_t delay
Encoded message execution delay in 5 millisecond steps.
int16_t present_level
The present value of the Generic Level state.
Message format for the generic_level Status message.
uint8_t delay
Encoded message execution delay in 5 millisecond steps.
uint8_t tid
Transaction number for application.

Documentation feedback | Developer Zone | Subscribe | Updated