ST Sigfox S2-LP User Manual Download Page 16

NAME

ARGUMENTS

DESCRIPTION

node_get_std_config

None

Returns the standard channel
configuration in memory

node_test_mode

RCZ: integer

Test_Mode: integer

Executes a specified test mode

get_lib_version

Lib_ID: Integer

0=Sigfox

1=MCU_API

2=RF_API

5=MONARCH_API

6=DEVICE_CONFIG_API

Gets version of specified module.

set_payload_encription

1: enable payload encryption

0: disable payload encryption

Enables payload encryption

set_frequency_offset

 -

DEPRECATED

(1)

Offset (Hz): real

Overrides default offset calibration

set_rssi_offset

Offset: real

Sets RSSI calibration value

get_rssi_offset

None

Returns the last RSSI offset in memory

node_send_bit

Bit to send: 1 or 0

Number of repetition: integer

Sends a single bit n times

node_open_with_zone

RCZ: integer

Opens Sigfox library with a specified
RC zone (see 

Table 9. Supported

Sigfox RC zones

)

switch_test_credentials

1: Enable test credentials

0: Disable test credentials

Enables credentials to be used during
Sigfox verified tests

 

1. Only for backward compatibility. Please, now refer to the set_xtal_frequency_offset command

 

Table 2. 

Sigfox Monarch RC Capabilities bitmask

Bit7

Bit6

Bit5

Bit4

Bit3

Bit2

Bit1

Bit0

-

-

RC6

RC5

RC4

RC3

RC2

RC1

Table 3. 

Continuous transmission types of modulation

Modulation mode

Value

No modulation

0

DBPSK 100bps

1

DBPSK 600bps

2

UM2169

Using the command line

UM2169

 - 

Rev 6

page 16/31

Summary of Contents for Sigfox S2-LP

Page 1: ...h the shields included in the above mentioned kits The latter solution enables the support for BlueNRG1 2 System on Chip alternatively to the STM32 microcontroller It provides an S2 LP Sigfox library...

Page 2: ...evelop embedded Sigfox enabled applications with examples in the source code an application note which describes the Sigfox firmware framework based on the S2 LP transceiver and on both STM32 MCU and...

Page 3: ...15V1 or X NUCLEO S2915A1 for RCZ2 and RCZ4 with STM32 Nucleo 64 development board or STEVAL IDB007V2 IDB008V2 board STEVAL FKI001V1 development kit 2 2 Software prerequisites Microsoft Windows 7 or la...

Page 4: ...mmer to the JTAG SWD connector Step 2 STM32 STEVAL FKI001V1 Flash the development board by simply dragging the appropriate bin file in the Binaries Sigfox_CLI_Demo_Project folder to the NODE drive Cho...

Page 5: ...Step 3 Open the ST Sigfox GUI and the COM port associated with the development board Figure 2 Sigfox Demo GUI main window UM2169 ST side registration UM2169 Rev 6 page 5 31...

Page 6: ...Step 4 Click on the Open button If the board does not contain Sigfox data a Board Preparation wizard appears Figure 3 ST Registration procedure 1 3 UM2169 ST side registration UM2169 Rev 6 page 6 31...

Page 7: ...nfiguration zone RCZ number Note You must specify the correct RC zone to avoid generating an incorrect ID Please refer to https build sigfox com sigfox radio configurations rc for the updated list of...

Page 8: ...with the Destination Address Subject and e mail text shown in the popup window You will receive an answer at the e mail address you specified previously with an activation string Step 8 Paste the act...

Page 9: ...ry where the board should operate the ID and PAC of the board Step 2 Then fill a form to obtain an account on the sigfox backend An e mail will be sent to the specified e mail address Step 3 Choose a...

Page 10: ...shown the date and time the data in hex so if the transmission occurred with the S2 LP Sigfox GUI the data should be the transmitted message in hex the location of the node link to a map a link qualit...

Page 11: ...ssages using the GUI Step 1 Flash the board with the appropriate Sigfox_CLI_Demo firmware located in the Binaries Sigfox_CLI_Demo_Project folder Step 2 Connect the STM32 Nucleo 64 or STEVAL FKI001V1 d...

Page 12: ...the sigfox backend Note The maximum length of a message is 12 bytes as per the sigfox protocol Step 6 Check the Ask for response checkbox and then click TX again The message is sent with a response r...

Page 13: ...32 only Close jumper JP1 in Figure 10 JP1 position on STM32 Nucleo board This allows the STM32 to execute the firmware program without being enumerated to a USB host device LED LD1 will blink and LD3...

Page 14: ...payload_encryption 0 no 1 yes Sets the encryption of the payload get_id None Returns the Sigfox ID of the board get_pac None Returns the Sigfox PAC of the board get_rcz None Returns the RCZ node_open...

Page 15: ...nsmission types of modulation Executes a continuous wave or modulation stop_continuous_transmission None Stops a continuous wave or modulation switch_pa 0 no 1 yes Sets or unsets the presence of the P...

Page 16: ...fset None Returns the last RSSI offset in memory node_send_bit Bit to send 1 or 0 Number of repetition integer Sends a single bit n times node_open_with_zone RCZ integer Opens Sigfox library with a sp...

Page 17: ...ses uplink Send uplink frames 3 Command example node_send_frame 012345 0 0 Command response node_send_frame API call sfx_error 00 downlink Send uplink frames 1 to 3 Receive downlink frame Send out of...

Page 18: ...ifications The last argument is an integer representing the sigfox_default_channel It should be set as follows For RCZ2 the operational frequency should be 902 2MHz and the default channel is 1 For RC...

Page 19: ...with KEIL Vision 5 for ARM Step 1 Open the KEIL Vision 5 for ARM and select Project Open Project Step 2 Open the KEIL project Projects Projects_Cube S2 LP_Sigfox_DK SigFox_PushButton_Project Step 3 S...

Page 20: ...tire test suite before the official certification The test procedure requires the RSA SDR Dongle kit from Sigfox Test can be performed calling the node_test_mode command specifying RCZ and Test ID 6 2...

Page 21: ...n the project in the EWARM folder Step 5 Select Project Rebuild All Step 6 Select Project Download and Debug to download the corresponding binary image 6 5 BlueNRG 1 2 support The STSW S2LP SFX DK SW...

Page 22: ...the STEVAL IDB007V2 and STEVAL IDB008V2 platform pin connection is as described the following table Table 11 STEVAL IDB007V2 platform pin description with board function Pin name Pin num Function LEDs...

Page 23: ...Arduino connectors CN1 4 and can be driven by the BlueNRG 1 2 via SPI GPIO3 is connected to the BlueNRG 1 2 wake up pin used to notify some events The BlueNRG 1 2 SoC acts as a SPI master and can be u...

Page 24: ...in the Flash memory is related to RCZ frequency offset RSSI offset LBT offset 6 6 1 Prerequisites To save credentials in your device using the tool ensure you have installed the right version of ST LI...

Page 25: ...F0 0x0801F000 STM32F4 0x08004000 BlueNRG 1 0x10066000 BlueNRG 2 0x1007E000 6 6 3 Encryption The Sigfox key can be optionally encrypted using an AES 128 bit encoding algorithm with a 16 byte long key T...

Page 26: ...6 4 BlueNRG 1 2 support Section 6 5 Hardware requirements Section 6 6 Changes to the STEVAL IDB007V1 2 and STEVALIDB008V1 2 boards Section 6 7 BlueNRG 1 SoC connections Section 6 8 S2 LP Section 6 9 E...

Page 27: ...nd_frame command description 17 4 3 3 node_set_std_config command description 17 5 Push button demo description 19 5 1 KEIL project 19 5 2 IAR project 19 6 Sigfox CLI demo description 20 6 1 STEVAL ID...

Page 28: ...6 5 4 E2PROM 23 6 5 5 Hardware setup 23 6 6 Sigfox Flasher 24 6 6 1 Prerequisites 24 6 6 2 Usage 24 6 6 3 Encryption 25 Revision history 26 UM2169 Contents UM2169 Rev 6 page 28 31...

Page 29: ...config_words 1 18 Table 7 Macro channel mapping config_words 2 18 Table 8 Default STD config 18 Table 9 Supported Sigfox RC zones 20 Table 10 Sigfox suitable test ID values 20 Table 11 STEVAL IDB007V...

Page 30: ...x device page 9 Figure 8 Sigfox device information 9 Figure 9 Sigfox device messages 10 Figure 10 JP1 position on STM32 Nucleo board 11 Figure 11 Sigfox Demo GUI main window 12 Figure 12 Sigfox DEVICE...

Page 31: ...ts and ST assumes no liability for application assistance or the design of Purchasers products No license express or implied to any intellectual property right is granted by ST herein Resale of ST pro...

Reviews: