nRF5 SDK for Mesh v5.0.0
nrf_mesh_serial.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 NRF_MESH_SERIAL_H__
39 #define NRF_MESH_SERIAL_H__
40 
41 #include <stdint.h>
42 #include <limits.h>
43 #include "nrf_mesh.h"
44 
58 #define NRF_MESH_SERIAL_PAYLOAD_MAXLEN (UINT8_MAX - 1)
59 
60 #define NRF_MESH_SERIAL_PACKET_OVERHEAD (1UL)
61 
70 typedef enum
71 {
76 
78 typedef void (*nrf_mesh_serial_app_rx_cb_t)(const uint8_t* p_data, uint32_t length);
79 
96 
108 uint32_t nrf_mesh_serial_enable(void);
109 
116 
133 uint32_t nrf_mesh_serial_tx(uint8_t* p_data, uint32_t length);
134 
137 #endif /* NRF_MESH_SERIAL_H__ */
138 
The serial module is running.
uint32_t nrf_mesh_serial_enable(void)
Enable the serial connection.
nrf_mesh_serial_state_t nrf_mesh_serial_state_get(void)
Get the current state of the serial module.
void(* nrf_mesh_serial_app_rx_cb_t)(const uint8_t *p_data, uint32_t length)
Serial RX callback function type for application events.
The serial module has been initialized, but not started.
nrf_mesh_serial_state_t
Mesh serial states.
The serial module hasn&#39;t been initialized.
uint32_t nrf_mesh_serial_init(nrf_mesh_serial_app_rx_cb_t app_rx_cb)
Initialize the serial module and all its related submodules.
uint32_t nrf_mesh_serial_tx(uint8_t *p_data, uint32_t length)
Transmit a serial packet with the APPLICATION_EVT opcode across the serial.

Documentation feedback | Developer Zone | Subscribe | Updated