ST
Prototype RF driver for STM Sub-1 GHz RF expansion board based on the SPSGRF-868 module for STM32 Nucleo.
Prototype RF Driver for STM Sub-1 GHz RF Expansion Boards based on the SPSGRF-868 and SPSGRF-915 Modules for STM32 Nucleo
Currently supported boards:
Note, in order to use expansion board X-NUCLEO-IDS01A4 in mbed you need to perform the following HW modifications on the board:
- Unmount resistor
R4 - Mount resistor
R7
Furthermore, on some Nucleo development boards (e.g. the NUCLEO_F429ZI), in order to be able to use Ethernet together with these Sub-1 GHz RF expansion boards, you need to compile this driver with macro SPIRIT1_SPI_MOSI=PB_5 defined, while the development board typically requires some HW modification as e.g. described here!
This driver can be used together with the 6LoWPAN stack (a.k.a. Nanostack).
libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_PktMbus.h@0:4fb29d9ee571, 2016-10-13 (annotated)
- Committer:
- Wolfgang Betz
- Date:
- Thu Oct 13 15:41:39 2016 +0200
- Revision:
- 0:4fb29d9ee571
First compiling version (without warnings)
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| Wolfgang Betz |
0:4fb29d9ee571 | 1 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 2 | ****************************************************************************** |
| Wolfgang Betz |
0:4fb29d9ee571 | 3 | * @file SPIRIT_PktMbus.h |
| Wolfgang Betz |
0:4fb29d9ee571 | 4 | * @author VMA division - AMS |
| Wolfgang Betz |
0:4fb29d9ee571 | 5 | * @version 3.2.2 |
| Wolfgang Betz |
0:4fb29d9ee571 | 6 | * @date 08-July-2015 |
| Wolfgang Betz |
0:4fb29d9ee571 | 7 | * @brief Configuration and management of SPIRIT MBUS packets. |
| Wolfgang Betz |
0:4fb29d9ee571 | 8 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 9 | * @details |
| Wolfgang Betz |
0:4fb29d9ee571 | 10 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 11 | * This module can be used to manage the configuration of Spirit MBUS |
| Wolfgang Betz |
0:4fb29d9ee571 | 12 | * packets. |
| Wolfgang Betz |
0:4fb29d9ee571 | 13 | * The user can obtain a packet configuration filling the structure |
| Wolfgang Betz |
0:4fb29d9ee571 | 14 | * <i>@ref PktMbusInit</i>, defining in it some general parameters |
| Wolfgang Betz |
0:4fb29d9ee571 | 15 | * for the Spirit MBUS packet format. |
| Wolfgang Betz |
0:4fb29d9ee571 | 16 | * Since the MBUS protocol is a standard, the configuration of a MBUS |
| Wolfgang Betz |
0:4fb29d9ee571 | 17 | * packet is very simple to do. |
| Wolfgang Betz |
0:4fb29d9ee571 | 18 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 19 | * <b>Example:</b> |
| Wolfgang Betz |
0:4fb29d9ee571 | 20 | * @code |
| Wolfgang Betz |
0:4fb29d9ee571 | 21 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 22 | * PktMbusInit mbusInit={ |
| Wolfgang Betz |
0:4fb29d9ee571 | 23 | * MBUS_SUBMODE_S1_S2_LONG_HEADER, // MBUS submode selection |
| Wolfgang Betz |
0:4fb29d9ee571 | 24 | * 36, // added "01" chips on preamble |
| Wolfgang Betz |
0:4fb29d9ee571 | 25 | * 16 // postamble length in "01" chips |
| Wolfgang Betz |
0:4fb29d9ee571 | 26 | * }; |
| Wolfgang Betz |
0:4fb29d9ee571 | 27 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 28 | * ... |
| Wolfgang Betz |
0:4fb29d9ee571 | 29 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 30 | * SpiritPktMbusInit(&mbusInit); |
| Wolfgang Betz |
0:4fb29d9ee571 | 31 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 32 | * ... |
| Wolfgang Betz |
0:4fb29d9ee571 | 33 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 34 | * @endcode |
| Wolfgang Betz |
0:4fb29d9ee571 | 35 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 36 | * The module provides some other functions that can be used to modify |
| Wolfgang Betz |
0:4fb29d9ee571 | 37 | * or read only some configuration parameters. |
| Wolfgang Betz |
0:4fb29d9ee571 | 38 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 39 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 40 | * @attention |
| Wolfgang Betz |
0:4fb29d9ee571 | 41 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 42 | * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> |
| Wolfgang Betz |
0:4fb29d9ee571 | 43 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 44 | * Redistribution and use in source and binary forms, with or without modification, |
| Wolfgang Betz |
0:4fb29d9ee571 | 45 | * are permitted provided that the following conditions are met: |
| Wolfgang Betz |
0:4fb29d9ee571 | 46 | * 1. Redistributions of source code must retain the above copyright notice, |
| Wolfgang Betz |
0:4fb29d9ee571 | 47 | * this list of conditions and the following disclaimer. |
| Wolfgang Betz |
0:4fb29d9ee571 | 48 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| Wolfgang Betz |
0:4fb29d9ee571 | 49 | * this list of conditions and the following disclaimer in the documentation |
| Wolfgang Betz |
0:4fb29d9ee571 | 50 | * and/or other materials provided with the distribution. |
| Wolfgang Betz |
0:4fb29d9ee571 | 51 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
| Wolfgang Betz |
0:4fb29d9ee571 | 52 | * may be used to endorse or promote products derived from this software |
| Wolfgang Betz |
0:4fb29d9ee571 | 53 | * without specific prior written permission. |
| Wolfgang Betz |
0:4fb29d9ee571 | 54 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 55 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| Wolfgang Betz |
0:4fb29d9ee571 | 56 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| Wolfgang Betz |
0:4fb29d9ee571 | 57 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| Wolfgang Betz |
0:4fb29d9ee571 | 58 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
| Wolfgang Betz |
0:4fb29d9ee571 | 59 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| Wolfgang Betz |
0:4fb29d9ee571 | 60 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| Wolfgang Betz |
0:4fb29d9ee571 | 61 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| Wolfgang Betz |
0:4fb29d9ee571 | 62 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| Wolfgang Betz |
0:4fb29d9ee571 | 63 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| Wolfgang Betz |
0:4fb29d9ee571 | 64 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| Wolfgang Betz |
0:4fb29d9ee571 | 65 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 66 | ****************************************************************************** |
| Wolfgang Betz |
0:4fb29d9ee571 | 67 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 68 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 69 | /* Define to prevent recursive inclusion -------------------------------------*/ |
| Wolfgang Betz |
0:4fb29d9ee571 | 70 | #ifndef __SPIRIT_PACKET_MBUS_H |
| Wolfgang Betz |
0:4fb29d9ee571 | 71 | #define __SPIRIT_PACKET_MBUS_H |
| Wolfgang Betz |
0:4fb29d9ee571 | 72 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 73 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 74 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 75 | /* Includes ------------------------------------------------------------------*/ |
| Wolfgang Betz |
0:4fb29d9ee571 | 76 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 77 | #include "SPIRIT_Regs.h" |
| Wolfgang Betz |
0:4fb29d9ee571 | 78 | #include "SPIRIT_Types.h" |
| Wolfgang Betz |
0:4fb29d9ee571 | 79 | #include "SPIRIT_PktCommon.h" |
| Wolfgang Betz |
0:4fb29d9ee571 | 80 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 81 | #ifdef __cplusplus |
| Wolfgang Betz |
0:4fb29d9ee571 | 82 | extern "C" { |
| Wolfgang Betz |
0:4fb29d9ee571 | 83 | #endif |
| Wolfgang Betz |
0:4fb29d9ee571 | 84 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 85 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 86 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 87 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 88 | * @addtogroup SPIRIT_Libraries |
| Wolfgang Betz |
0:4fb29d9ee571 | 89 | * @{ |
| Wolfgang Betz |
0:4fb29d9ee571 | 90 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 91 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 92 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 93 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 94 | * @defgroup SPIRIT_PktMbus Pkt MBUS |
| Wolfgang Betz |
0:4fb29d9ee571 | 95 | * @brief Configuration and management of SPIRIT MBUS packets. |
| Wolfgang Betz |
0:4fb29d9ee571 | 96 | * @details See the file <i>@ref SPIRIT_PktMbus.h</i> for more details. |
| Wolfgang Betz |
0:4fb29d9ee571 | 97 | * @{ |
| Wolfgang Betz |
0:4fb29d9ee571 | 98 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 99 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 100 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 101 | * @defgroup PktMbus_Exported_Types Pkt MBUS Exported Types |
| Wolfgang Betz |
0:4fb29d9ee571 | 102 | * @{ |
| Wolfgang Betz |
0:4fb29d9ee571 | 103 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 104 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 105 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 106 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 107 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 108 | * @brief MBUS submode enumeration. |
| Wolfgang Betz |
0:4fb29d9ee571 | 109 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 110 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 111 | typedef enum |
| Wolfgang Betz |
0:4fb29d9ee571 | 112 | { |
| Wolfgang Betz |
0:4fb29d9ee571 | 113 | MBUS_SUBMODE_S1_S2_LONG_HEADER = MBUS_CTRL_MBUS_SUBMODE_S1_S2L, /*!< MBUS submode S1, S2 (long header) - Header length = mbus_prmbl_ctrl + 279 (in "01" bit pairs) , Sync word = 0x7696 (length 18 bits) */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 114 | MBUS_SUBMODE_S1_M_S2_T2_OTHER_TO_METER = MBUS_CTRL_MBUS_SUBMODE_S2_S1M_T2_OTHER, /*!< MBUS submode S1-m, S2, T2 (other to meter) - Header length = mbus_prmbl_ctrl + 15 (in "01" bit pairs) , Sync word = 0x7696 (length 18 bits)*/ |
| Wolfgang Betz |
0:4fb29d9ee571 | 115 | MBUS_SUBMODE_T1_T2_METER_TO_OTHER = MBUS_CTRL_MBUS_SUBMODE_T1_T2_METER, /*!< MBUS submode T1, T2 (meter to other) - Header length = mbus_prmbl_ctrl + 19 (in "01" bit pairs) , Sync word = 0x3D (length 10 bits)*/ |
| Wolfgang Betz |
0:4fb29d9ee571 | 116 | MBUS_SUBMODE_R2_SHORT_HEADER = MBUS_CTRL_MBUS_SUBMODE_R2, /*!< MBUS submode R2, short header - Header length = mbus_prmbl_ctrl + 39 (in "01" bit pairs) , Sync word = 0x7696 (length 18 bits)*/ |
| Wolfgang Betz |
0:4fb29d9ee571 | 117 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 118 | }MbusSubmode; |
| Wolfgang Betz |
0:4fb29d9ee571 | 119 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 120 | #define IS_MBUS_SUBMODE(MODE) (((MODE) == MBUS_SUBMODE_S1_S2_LONG_HEADER) || \ |
| Wolfgang Betz |
0:4fb29d9ee571 | 121 | ((MODE) == MBUS_SUBMODE_S1_M_S2_T2_OTHER_TO_METER) || \ |
| Wolfgang Betz |
0:4fb29d9ee571 | 122 | ((MODE) == MBUS_SUBMODE_T1_T2_METER_TO_OTHER) || \ |
| Wolfgang Betz |
0:4fb29d9ee571 | 123 | ((MODE) == MBUS_SUBMODE_R2_SHORT_HEADER)) |
| Wolfgang Betz |
0:4fb29d9ee571 | 124 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 125 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 126 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 127 | * @brief SPIRIT MBUS Packet Init structure definition |
| Wolfgang Betz |
0:4fb29d9ee571 | 128 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 129 | typedef struct |
| Wolfgang Betz |
0:4fb29d9ee571 | 130 | { |
| Wolfgang Betz |
0:4fb29d9ee571 | 131 | MbusSubmode xMbusSubmode; /*!< Specifies the SUBMODE to be configured. |
| Wolfgang Betz |
0:4fb29d9ee571 | 132 | This parameter can be a value of @ref MbusSubmode */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 133 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 134 | uint8_t cPreambleLength; /*!< Specifies the PREAMBLE length. |
| Wolfgang Betz |
0:4fb29d9ee571 | 135 | This parameter can be any value between 0 and 255 chip sequence '01' */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 136 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 137 | uint8_t cPostambleLength; /*!< Specifies the POSTAMBLE length. |
| Wolfgang Betz |
0:4fb29d9ee571 | 138 | This parameter can be any value between 0 and 255 chip sequence '01' */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 139 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 140 | }PktMbusInit; |
| Wolfgang Betz |
0:4fb29d9ee571 | 141 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 142 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 143 | *@} |
| Wolfgang Betz |
0:4fb29d9ee571 | 144 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 145 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 146 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 147 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 148 | * @defgroup PktMbus_Exported_Constants Pkt MBUS Exported Constants |
| Wolfgang Betz |
0:4fb29d9ee571 | 149 | * @{ |
| Wolfgang Betz |
0:4fb29d9ee571 | 150 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 151 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 152 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 153 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 154 | *@} |
| Wolfgang Betz |
0:4fb29d9ee571 | 155 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 156 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 157 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 158 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 159 | * @defgroup PktMbus_Exported_Macros Pkt MBUS Exported Macros |
| Wolfgang Betz |
0:4fb29d9ee571 | 160 | * @{ |
| Wolfgang Betz |
0:4fb29d9ee571 | 161 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 162 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 163 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 164 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 165 | *@} |
| Wolfgang Betz |
0:4fb29d9ee571 | 166 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 167 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 168 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 169 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 170 | * @defgroup PktMbus_Exported_Functions Pkt MBUS Exported Functions |
| Wolfgang Betz |
0:4fb29d9ee571 | 171 | * @{ |
| Wolfgang Betz |
0:4fb29d9ee571 | 172 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 173 | void SpiritPktMbusInit(PktMbusInit* pxPktMbusInit); |
| Wolfgang Betz |
0:4fb29d9ee571 | 174 | void SpiritPktMbusGetInfo(PktMbusInit* pxPktMbusInit); |
| Wolfgang Betz |
0:4fb29d9ee571 | 175 | void SpiritPktMbusSetFormat(void); |
| Wolfgang Betz |
0:4fb29d9ee571 | 176 | void SpiritPktMbusSetPreamble(uint8_t cPreamble); |
| Wolfgang Betz |
0:4fb29d9ee571 | 177 | uint8_t SpiritPktMbusGetPreamble(void); |
| Wolfgang Betz |
0:4fb29d9ee571 | 178 | void SpiritPktMbusSetPostamble(uint8_t cPostamble); |
| Wolfgang Betz |
0:4fb29d9ee571 | 179 | uint8_t SpiritPktMbusGetPostamble(void); |
| Wolfgang Betz |
0:4fb29d9ee571 | 180 | void SpiritPktMbusSetSubmode(MbusSubmode xMbusSubmode); |
| Wolfgang Betz |
0:4fb29d9ee571 | 181 | MbusSubmode SpiritPktMbusGetSubmode(void); |
| Wolfgang Betz |
0:4fb29d9ee571 | 182 | void SpiritPktMbusSetPayloadLength(uint16_t nPayloadLength); |
| Wolfgang Betz |
0:4fb29d9ee571 | 183 | uint16_t SpiritPktMbusGetPayloadLength(void); |
| Wolfgang Betz |
0:4fb29d9ee571 | 184 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 185 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 186 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 187 | *@} |
| Wolfgang Betz |
0:4fb29d9ee571 | 188 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 189 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 190 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 191 | *@} |
| Wolfgang Betz |
0:4fb29d9ee571 | 192 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 193 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 194 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 195 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 196 | *@} |
| Wolfgang Betz |
0:4fb29d9ee571 | 197 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 198 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 199 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 200 | #ifdef __cplusplus |
| Wolfgang Betz |
0:4fb29d9ee571 | 201 | } |
| Wolfgang Betz |
0:4fb29d9ee571 | 202 | #endif |
| Wolfgang Betz |
0:4fb29d9ee571 | 203 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 204 | #endif |
| Wolfgang Betz |
0:4fb29d9ee571 | 205 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 206 | /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/ |
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 05 Jul 2017 |
| Imports: | 273 |
| Forks: | 2 |
| Commits: | 83 |
| Dependents: | 0 |
| Dependencies: | 0 |
| Followers: | 410 |
The code in this repository is Apache licensed.
Components
X-NUCLEO-IDS01A4 Sub-1GHz RF Expansion Board