ST / stm-spirit1-rf-driver

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).

source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_PktMbus.h@67:93bec0baf1de, 2017-07-06 (annotated)

Committer:
Wolfgang Betz
Date:
Thu Jul 06 11:13:31 2017 +0200
Revision:
67:93bec0baf1de
Parent:
34:edda6a7238ec 
Clarify some comments

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 67:93bec0baf1de 1 /**
Wolfgang Betz 67:93bec0baf1de 2 ******************************************************************************
Wolfgang Betz 67:93bec0baf1de 3 * @file SPIRIT_PktMbus.h
Wolfgang Betz 67:93bec0baf1de 4 * @author VMA division - AMS
Wolfgang Betz 67:93bec0baf1de 5 * @version 3.2.2
Wolfgang Betz 67:93bec0baf1de 6 * @date 08-July-2015
Wolfgang Betz 67:93bec0baf1de 7 * @brief Configuration and management of SPIRIT MBUS packets.
Wolfgang Betz 67:93bec0baf1de 8 *
Wolfgang Betz 67:93bec0baf1de 9 * @details
Wolfgang Betz 67:93bec0baf1de 10 *
Wolfgang Betz 67:93bec0baf1de 11 * This module can be used to manage the configuration of Spirit MBUS
Wolfgang Betz 67:93bec0baf1de 12 * packets.
Wolfgang Betz 67:93bec0baf1de 13 * The user can obtain a packet configuration filling the structure
Wolfgang Betz 67:93bec0baf1de 14 * <i>@ref PktMbusInit</i>, defining in it some general parameters
Wolfgang Betz 67:93bec0baf1de 15 * for the Spirit MBUS packet format.
Wolfgang Betz 67:93bec0baf1de 16 * Since the MBUS protocol is a standard, the configuration of a MBUS
Wolfgang Betz 67:93bec0baf1de 17 * packet is very simple to do.
Wolfgang Betz 67:93bec0baf1de 18 *
Wolfgang Betz 67:93bec0baf1de 19 * <b>Example:</b>
Wolfgang Betz 67:93bec0baf1de 20 * @code
Wolfgang Betz 67:93bec0baf1de 21 *
Wolfgang Betz 67:93bec0baf1de 22 * PktMbusInit mbusInit={
Wolfgang Betz 67:93bec0baf1de 23 * MBUS_SUBMODE_S1_S2_LONG_HEADER, // MBUS submode selection
Wolfgang Betz 67:93bec0baf1de 24 * 36, // added "01" chips on preamble
Wolfgang Betz 67:93bec0baf1de 25 * 16 // postamble length in "01" chips
Wolfgang Betz 67:93bec0baf1de 26 * };
Wolfgang Betz 67:93bec0baf1de 27 *
Wolfgang Betz 67:93bec0baf1de 28 * ...
Wolfgang Betz 67:93bec0baf1de 29 *
Wolfgang Betz 67:93bec0baf1de 30 * SpiritPktMbusInit(&mbusInit);
Wolfgang Betz 67:93bec0baf1de 31 *
Wolfgang Betz 67:93bec0baf1de 32 * ...
Wolfgang Betz 67:93bec0baf1de 33 *
Wolfgang Betz 67:93bec0baf1de 34 * @endcode
Wolfgang Betz 67:93bec0baf1de 35 *
Wolfgang Betz 67:93bec0baf1de 36 * The module provides some other functions that can be used to modify
Wolfgang Betz 67:93bec0baf1de 37 * or read only some configuration parameters.
Wolfgang Betz 67:93bec0baf1de 38 *
Wolfgang Betz 67:93bec0baf1de 39 *
Wolfgang Betz 67:93bec0baf1de 40 * @attention
Wolfgang Betz 67:93bec0baf1de 41 *
Wolfgang Betz 67:93bec0baf1de 42 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 67:93bec0baf1de 43 *
Wolfgang Betz 67:93bec0baf1de 44 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 67:93bec0baf1de 45 * are permitted provided that the following conditions are met:
Wolfgang Betz 67:93bec0baf1de 46 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 67:93bec0baf1de 47 * this list of conditions and the following disclaimer.
Wolfgang Betz 67:93bec0baf1de 48 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 67:93bec0baf1de 49 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 67:93bec0baf1de 50 * and/or other materials provided with the distribution.
Wolfgang Betz 67:93bec0baf1de 51 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 67:93bec0baf1de 52 * may be used to endorse or promote products derived from this software
Wolfgang Betz 67:93bec0baf1de 53 * without specific prior written permission.
Wolfgang Betz 67:93bec0baf1de 54 *
Wolfgang Betz 67:93bec0baf1de 55 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 67:93bec0baf1de 56 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 67:93bec0baf1de 57 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 67:93bec0baf1de 58 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 67:93bec0baf1de 59 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 67:93bec0baf1de 60 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 67:93bec0baf1de 61 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 67:93bec0baf1de 62 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 67:93bec0baf1de 63 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 67:93bec0baf1de 64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 67:93bec0baf1de 65 *
Wolfgang Betz 67:93bec0baf1de 66 ******************************************************************************
Wolfgang Betz 67:93bec0baf1de 67 */
Wolfgang Betz 67:93bec0baf1de 68
Wolfgang Betz 67:93bec0baf1de 69 /* Define to prevent recursive inclusion -------------------------------------*/
Wolfgang Betz 67:93bec0baf1de 70 #ifndef __SPIRIT_PACKET_MBUS_H
Wolfgang Betz 67:93bec0baf1de 71 #define __SPIRIT_PACKET_MBUS_H
Wolfgang Betz 67:93bec0baf1de 72
Wolfgang Betz 67:93bec0baf1de 73
Wolfgang Betz 67:93bec0baf1de 74
Wolfgang Betz 67:93bec0baf1de 75 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 67:93bec0baf1de 76
Wolfgang Betz 67:93bec0baf1de 77 #include "SPIRIT_Regs.h"
Wolfgang Betz 67:93bec0baf1de 78 #include "SPIRIT_Types.h"
Wolfgang Betz 67:93bec0baf1de 79 #include "SPIRIT_PktCommon.h"
Wolfgang Betz 67:93bec0baf1de 80
Wolfgang Betz 67:93bec0baf1de 81 #ifdef __cplusplus
Wolfgang Betz 67:93bec0baf1de 82 extern "C" {
Wolfgang Betz 67:93bec0baf1de 83 #endif
Wolfgang Betz 67:93bec0baf1de 84
Wolfgang Betz 67:93bec0baf1de 85
Wolfgang Betz 67:93bec0baf1de 86
Wolfgang Betz 67:93bec0baf1de 87 /**
Wolfgang Betz 67:93bec0baf1de 88 * @addtogroup SPIRIT_Libraries
Wolfgang Betz 67:93bec0baf1de 89 * @{
Wolfgang Betz 67:93bec0baf1de 90 */
Wolfgang Betz 67:93bec0baf1de 91
Wolfgang Betz 67:93bec0baf1de 92
Wolfgang Betz 67:93bec0baf1de 93 /**
Wolfgang Betz 67:93bec0baf1de 94 * @defgroup SPIRIT_PktMbus Pkt MBUS
Wolfgang Betz 67:93bec0baf1de 95 * @brief Configuration and management of SPIRIT MBUS packets.
Wolfgang Betz 67:93bec0baf1de 96 * @details See the file <i>@ref SPIRIT_PktMbus.h</i> for more details.
Wolfgang Betz 67:93bec0baf1de 97 * @{
Wolfgang Betz 67:93bec0baf1de 98 */
Wolfgang Betz 67:93bec0baf1de 99
Wolfgang Betz 67:93bec0baf1de 100 /**
Wolfgang Betz 67:93bec0baf1de 101 * @defgroup PktMbus_Exported_Types Pkt MBUS Exported Types
Wolfgang Betz 67:93bec0baf1de 102 * @{
Wolfgang Betz 67:93bec0baf1de 103 */
Wolfgang Betz 67:93bec0baf1de 104
Wolfgang Betz 67:93bec0baf1de 105
Wolfgang Betz 67:93bec0baf1de 106
Wolfgang Betz 67:93bec0baf1de 107 /**
Wolfgang Betz 67:93bec0baf1de 108 * @brief MBUS submode enumeration.
Wolfgang Betz 67:93bec0baf1de 109 */
Wolfgang Betz 67:93bec0baf1de 110
Wolfgang Betz 67:93bec0baf1de 111 typedef enum
Wolfgang Betz 67:93bec0baf1de 112 {
Wolfgang Betz 67:93bec0baf1de 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 67:93bec0baf1de 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 67:93bec0baf1de 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 67:93bec0baf1de 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 67:93bec0baf1de 117
Wolfgang Betz 67:93bec0baf1de 118 }MbusSubmode;
Wolfgang Betz 67:93bec0baf1de 119
Wolfgang Betz 67:93bec0baf1de 120 #define IS_MBUS_SUBMODE(MODE) (((MODE) == MBUS_SUBMODE_S1_S2_LONG_HEADER) || \
Wolfgang Betz 67:93bec0baf1de 121 ((MODE) == MBUS_SUBMODE_S1_M_S2_T2_OTHER_TO_METER) || \
Wolfgang Betz 67:93bec0baf1de 122 ((MODE) == MBUS_SUBMODE_T1_T2_METER_TO_OTHER) || \
Wolfgang Betz 67:93bec0baf1de 123 ((MODE) == MBUS_SUBMODE_R2_SHORT_HEADER))
Wolfgang Betz 67:93bec0baf1de 124
Wolfgang Betz 67:93bec0baf1de 125
Wolfgang Betz 67:93bec0baf1de 126 /**
Wolfgang Betz 67:93bec0baf1de 127 * @brief SPIRIT MBUS Packet Init structure definition
Wolfgang Betz 67:93bec0baf1de 128 */
Wolfgang Betz 67:93bec0baf1de 129 typedef struct
Wolfgang Betz 67:93bec0baf1de 130 {
Wolfgang Betz 67:93bec0baf1de 131 MbusSubmode xMbusSubmode; /*!< Specifies the SUBMODE to be configured.
Wolfgang Betz 67:93bec0baf1de 132 This parameter can be a value of @ref MbusSubmode */
Wolfgang Betz 67:93bec0baf1de 133
Wolfgang Betz 67:93bec0baf1de 134 uint8_t cPreambleLength; /*!< Specifies the PREAMBLE length.
Wolfgang Betz 67:93bec0baf1de 135 This parameter can be any value between 0 and 255 chip sequence '01' */
Wolfgang Betz 67:93bec0baf1de 136
Wolfgang Betz 67:93bec0baf1de 137 uint8_t cPostambleLength; /*!< Specifies the POSTAMBLE length.
Wolfgang Betz 67:93bec0baf1de 138 This parameter can be any value between 0 and 255 chip sequence '01' */
Wolfgang Betz 67:93bec0baf1de 139
Wolfgang Betz 67:93bec0baf1de 140 }PktMbusInit;
Wolfgang Betz 67:93bec0baf1de 141
Wolfgang Betz 67:93bec0baf1de 142 /**
Wolfgang Betz 67:93bec0baf1de 143 *@}
Wolfgang Betz 67:93bec0baf1de 144 */
Wolfgang Betz 67:93bec0baf1de 145
Wolfgang Betz 67:93bec0baf1de 146
Wolfgang Betz 67:93bec0baf1de 147 /**
Wolfgang Betz 67:93bec0baf1de 148 * @defgroup PktMbus_Exported_Constants Pkt MBUS Exported Constants
Wolfgang Betz 67:93bec0baf1de 149 * @{
Wolfgang Betz 67:93bec0baf1de 150 */
Wolfgang Betz 67:93bec0baf1de 151
Wolfgang Betz 67:93bec0baf1de 152
Wolfgang Betz 67:93bec0baf1de 153 /**
Wolfgang Betz 67:93bec0baf1de 154 *@}
Wolfgang Betz 67:93bec0baf1de 155 */
Wolfgang Betz 67:93bec0baf1de 156
Wolfgang Betz 67:93bec0baf1de 157
Wolfgang Betz 67:93bec0baf1de 158 /**
Wolfgang Betz 67:93bec0baf1de 159 * @defgroup PktMbus_Exported_Macros Pkt MBUS Exported Macros
Wolfgang Betz 67:93bec0baf1de 160 * @{
Wolfgang Betz 67:93bec0baf1de 161 */
Wolfgang Betz 67:93bec0baf1de 162
Wolfgang Betz 67:93bec0baf1de 163
Wolfgang Betz 67:93bec0baf1de 164 /**
Wolfgang Betz 67:93bec0baf1de 165 *@}
Wolfgang Betz 67:93bec0baf1de 166 */
Wolfgang Betz 67:93bec0baf1de 167
Wolfgang Betz 67:93bec0baf1de 168
Wolfgang Betz 67:93bec0baf1de 169 /**
Wolfgang Betz 67:93bec0baf1de 170 * @defgroup PktMbus_Exported_Functions Pkt MBUS Exported Functions
Wolfgang Betz 67:93bec0baf1de 171 * @{
Wolfgang Betz 67:93bec0baf1de 172 */
Wolfgang Betz 67:93bec0baf1de 173 void SpiritPktMbusInit(PktMbusInit* pxPktMbusInit);
Wolfgang Betz 67:93bec0baf1de 174 void SpiritPktMbusGetInfo(PktMbusInit* pxPktMbusInit);
Wolfgang Betz 67:93bec0baf1de 175 void SpiritPktMbusSetFormat(void);
Wolfgang Betz 67:93bec0baf1de 176 void SpiritPktMbusSetPreamble(uint8_t cPreamble);
Wolfgang Betz 67:93bec0baf1de 177 uint8_t SpiritPktMbusGetPreamble(void);
Wolfgang Betz 67:93bec0baf1de 178 void SpiritPktMbusSetPostamble(uint8_t cPostamble);
Wolfgang Betz 67:93bec0baf1de 179 uint8_t SpiritPktMbusGetPostamble(void);
Wolfgang Betz 67:93bec0baf1de 180 void SpiritPktMbusSetSubmode(MbusSubmode xMbusSubmode);
Wolfgang Betz 67:93bec0baf1de 181 MbusSubmode SpiritPktMbusGetSubmode(void);
Wolfgang Betz 67:93bec0baf1de 182 void SpiritPktMbusSetPayloadLength(uint16_t nPayloadLength);
Wolfgang Betz 67:93bec0baf1de 183 uint16_t SpiritPktMbusGetPayloadLength(void);
Wolfgang Betz 67:93bec0baf1de 184
Wolfgang Betz 67:93bec0baf1de 185
Wolfgang Betz 67:93bec0baf1de 186 /**
Wolfgang Betz 67:93bec0baf1de 187 *@}
Wolfgang Betz 67:93bec0baf1de 188 */
Wolfgang Betz 67:93bec0baf1de 189
Wolfgang Betz 67:93bec0baf1de 190 /**
Wolfgang Betz 67:93bec0baf1de 191 *@}
Wolfgang Betz 67:93bec0baf1de 192 */
Wolfgang Betz 67:93bec0baf1de 193
Wolfgang Betz 67:93bec0baf1de 194
Wolfgang Betz 67:93bec0baf1de 195 /**
Wolfgang Betz 67:93bec0baf1de 196 *@}
Wolfgang Betz 67:93bec0baf1de 197 */
Wolfgang Betz 67:93bec0baf1de 198
Wolfgang Betz 67:93bec0baf1de 199
Wolfgang Betz 67:93bec0baf1de 200 #ifdef __cplusplus
Wolfgang Betz 67:93bec0baf1de 201 }
Wolfgang Betz 67:93bec0baf1de 202 #endif
Wolfgang Betz 67:93bec0baf1de 203
Wolfgang Betz 67:93bec0baf1de 204 #endif
Wolfgang Betz 67:93bec0baf1de 205
Wolfgang Betz 67:93bec0baf1de 206 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/