nRF5 SDK for Mesh v5.0.0
scene_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 SCENE_MESSAGES_H__
39 #define SCENE_MESSAGES_H__
40 
41 #include <stdint.h>
42 #include "scene_common.h"
52 #define SCENE_STORE_DELETE_LEN 2
53 
55 #define SCENE_RECALL_MINLEN 3
56 
57 #define SCENE_RECALL_MAXLEN 5
58 
60 #define SCENE_STATUS_MINLEN 3
61 
62 #define SCENE_STATUS_MAXLEN 6
63 
65 #define SCENE_REGISTER_STATUS_MINLEN 3
66 
67 #define SCENE_REGISTER_STATUS_MAXLEN (SCENE_REGISTER_STATUS_MINLEN + (2 * SCENE_REGISTER_ARRAY_SIZE))
68 
70 typedef enum
71 {
72  SCENE_OPCODE_GET = 0x8241,
73  SCENE_OPCODE_RECALL = 0x8242,
74  SCENE_OPCODE_RECALL_UNACKNOWLEDGED = 0x8243,
75  SCENE_OPCODE_STATUS = 0x5E,
76  SCENE_OPCODE_REGISTER_GET = 0x8244,
77  SCENE_OPCODE_REGISTER_STATUS = 0x8245,
78  SCENE_OPCODE_STORE = 0x8246,
79  SCENE_OPCODE_STORE_UNACKNOWLEDGED = 0x8247,
80  SCENE_OPCODE_DELETE = 0x829E,
81  SCENE_OPCODE_DELETE_UNACKNOWLEDGED = 0x829F,
82 } scene_opcode_t;
83 
87 typedef struct __attribute((packed))
88 {
89  uint16_t scene_number;
91 
93 typedef struct __attribute((packed))
94 {
95  uint16_t scene_number;
96  uint8_t tid;
97  uint8_t transition_time;
98  uint8_t delay;
100 
102 typedef struct __attribute((packed))
103 {
104  uint8_t status_code;
105  uint16_t current_scene;
106  uint16_t target_scene;
107  uint8_t remaining_time;
109 
123 typedef struct __attribute((packed))
124 {
125  uint8_t status_code;
126  uint16_t current_scene;
127  uint16_t scenes[];
129 
131 typedef struct __attribute((packed))
132 {
133  uint16_t scene_number;
135 
137 #endif /* SCENE_MESSAGES_H__ */
Message format for the Scene Register Status message 5.2.2.8 Scene Register Status Scene Register Sta...
uint16_t scene_number
Number of the scene to be stored.
uint8_t status_code
Status code for the last operation.
Message format for the Scene Status message.
uint8_t delay
Encoded message execution delay in 5 millisecond steps.
uint16_t scene_number
Number of the scene to be stored.
uint8_t remaining_time
Encoded remaining transition time.
uint16_t current_scene
Scene number of a current scene.
uint16_t current_scene
Scene number of a current scene.
Packed message structure typedefs are used for packing and unpacking byte stream. ...
Message format for the Scene Delete message.
uint16_t target_scene
Scene number of a target scene.
Message format for the Scene Recall message.
uint8_t tid
Transaction number for application.
uint16_t scene_number
Number of the scene to be deleted.
uint8_t status_code
Status code for the last operation.
uint8_t transition_time
Encoded transition time value.

Documentation feedback | Developer Zone | Subscribe | Updated