XDK API  3.6.0
Documentation
Functions
Sigfox.h File Reference
#include "BCDS_HAL.h"
#include "BCDS_Retcode.h"
#include "SigfoxConfig.h"
+ Include dependency graph for Sigfox.h:
+ This graph shows which files directly or indirectly include this file:

Functions

Retcode_T Sigfox_Enable (void)
 This will enable the Sigfox communication. It wakes up the chip and prepares it for further communication exchange. More...
 
Retcode_T Sigfox_GetInfo (void)
 Send getInfo command to SOC OL2385 to get ID and PAC and lib version. More...
 
Retcode_T Sigfox_GetSOCVersion (void)
 Retrieve device & software version of OL2385 chip. More...
 
void Sigfox_PrintRXPayload (void)
 Print Downlink Payload. More...
 
Retcode_T Sigfox_ReadPACurve (uint8_t subcommand)
 Read PA Curve. Only subcommands 0-ReadETSIPATable and 3-ReadFCCPATable are supported. More...
 
Retcode_T Sigfox_ResetMacroChannel (void)
 Reset Macrochannel (for RCZ2 and RCZ4 only) More...
 
Retcode_T Sigfox_SendBit (void)
 Send sigfox empty frame. More...
 
Retcode_T Sigfox_SendPayload (uint8_t *payload, uint8_t payloadSize, bool downlinkFlag)
 Send sigfox payload. More...
 
Retcode_T Sigfox_SendToSleep (void)
 Send Innocomm chipset to sleep mode. More...
 
Retcode_T Sigfox_SendWakeUp (void)
 Send wakeup command to SOC OL2385. Should be used before sending a payload as SOC goes in sleep mode automatically. More...
 
Retcode_T Sigfox_SetFCCMacroChannel (uint32_t *configWords, uint8_t defaultChannelConfig)
 Set FCC Macrochannel. config_words[0] are for Channels 1 to 32 (902.2MHz to 911.5MHz) config_words[1] are for Channels 33 to 64 (911.8MHz to 921.1MHz) config_words[2] are for Channels 65 to 86 (921.4MHz to 927.7MHz) More...
 
Retcode_T Sigfox_SetPrivateKey (void)
 Set AES Private Key (default mode) More...
 
Retcode_T Sigfox_SetPublicKey (void)
 Set AES Public Key (to use with SNEK) More...
 
Retcode_T Sigfox_SetRCZ1 (void)
 Set Radio Zone 1 (ETSI) More...
 
Retcode_T Sigfox_SetRCZ2 (void)
 Set Radio Zone 2. More...
 
Retcode_T Sigfox_SetRCZ3 (void)
 Set Radio Zone 3. More...
 
Retcode_T Sigfox_SetRCZ4 (void)
 Set Radio Zone 4. More...
 
Retcode_T Sigfox_Setup (void)
 This will setup the Sigfox communication by initializing the SPI interface with the chip and allocating the necessary buffers for memory. More...
 
Retcode_T Sigfox_UpdatePACurve (uint8_t subcommand)
 Update PA Curve. Only subcommands 1-UpdateETSIPATable and 4-UpdateFCCPATable are supported PA Curves tables are hardcoded in Sigfox.c file. More...
 

Function Documentation

Retcode_T Sigfox_Enable ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • Sigfox_Setup must have been successful prior.
  • Do not call this API more than once.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_GetInfo ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_GetSOCVersion ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

void Sigfox_PrintRXPayload ( void  )

Refer interface header for description

Retcode_T Sigfox_ReadPACurve ( uint8_t  subcommand)
Parameters
subcommand Subcommand Code (Only 0 and 3 implemented)
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_ResetMacroChannel ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_SendBit ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_SendPayload ( uint8_t *  payload,
uint8_t  payloadSize,
bool  downlinkFlag 
)
Parameters
payload sigfox payload to send
payloadSize size of payload in bytes
downlinkFlag Enable Downlink reception
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_SendToSleep ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_SendWakeUp ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • In-case Sigfox_Enable was called before we can proceed with first send since it .

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Retcode_T Sigfox_SetFCCMacroChannel ( uint32_t *  configWords,
uint8_t  defaultChannelConfig 
)
Parameters
configWords Config Words for Macro Channels
defaultChannelConfig Default Channel
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_SetPrivateKey ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_SetPublicKey ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_SetRCZ1 ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_SetRCZ2 ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_SetRCZ3 ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_SetRCZ4 ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_Setup ( void  )

Licensee agrees that the example code provided to Licensee has been developed and released by Bosch solely as an example to be used as a potential reference for Licensee’s application development. Fitness and suitability of the example code for any use within Licensee’s applications need to be verified by Licensee on its own authority by taking appropriate state of the art actions and measures (e.g. by means of quality assurance measures). Licensee shall be responsible for conducting the development of its applications as well as integration of parts of the example code into such applications, taking into account the state of the art of technology and any statutory regulations and provisions applicable for such applications. Compliance with the functional system requirements and testing there of (including validation of information/data security aspects and functional safety) and release shall be solely incumbent upon Licensee. For the avoidance of doubt, Licensee shall be responsible and fully liable for the applications and any distribution of such applications into the market.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

(1) Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

(2) Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.

(3)The name of the author may not be used to
endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • This must be the first API to be called if Sigfox feature is to be used.
  • Do not call this API more than once.
  • #BSP_ExtensionPort_Connect must have been successful prior.

Refer interface header for description

+ Here is the call graph for this function:

Retcode_T Sigfox_UpdatePACurve ( uint8_t  subcommand)
Parameters
subcommand Subcommand Code (Only 1 and 4 implemented)
Returns
RETCODE_OK on success, or an error code otherwise.

Refer interface header for description

+ Here is the call graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:39 by doxygen 1.8.8