OL2385SWUG datasheet(25/64 Pages) NXP

25 / 64 page

NXP Semiconductors

OL2385SWUG

SIGFOX software driver

OL2385SWUG

All information provided in this document is subject to legal disclaimers.

User guide

Rev. 2.1 — 6 April 2018

25 / 64

• netStandard selects a standard for defining network communication parameters

• txAttSteps contains number of 0.25 dB steps that needs to be subtracted from the TX

power

• xtal selects between usage of 55.2 MHz and 27.6 MHz TCXO XTAL

• paType selects between internal PA being used: 14 dBm or 0 dBm

• txRepeat selects number of transmissions that will happen when invoking

SF_SendPayload function (1TX or 3TX).

For a more detailed description of the user configuration structure, refer to the API

programmer's guide included in the SIGFOX software driver zip file.

6.2.4.2 Driver API

This software driver provides an API that allows user application code to configure the

device in real time. For a summary of the available functions, see Table 4.

Table 5. SIGFOX software driver API

Function

Description

SF_Init

Initializes the SIGFOX driver based on user configuration

SF_GetDefaultConfig

Loads the user configuration structure with default values

SF_SendCommand

Sends a command to the device. This function waits for an acknowledgment (if any)

SF_WakeUp

Sends the

Send_Wakeup command to wake up the device from power down mode

SF_Sleep

Puts the device in power off mode by means of the

Send_To_Sleep command

SF_SetUlFrequency

Sets the uplink frequency of the SIGFOX device

SF_GetUlFrequency

Gets the uplink frequency of the SIGFOX device

SF_SendPayload

Sends the

Send_Payload command to the device, which sends user data to SIGFOX network

SF_SendBit

Sends the

Send_Bit command, which transmits a single bit to the SIGFOX network. This is the

shortest frame that the SIGFOX library can generate. This command is useful for network testing.

SF_SendOutOfBand

Sends the

Send_out_of_band frame, which transmits data to the SIGFOX network. Data is

composed of information about the chip itself (voltage, temperature). This function must either

be called at least once every 24 hours or never, depending on whether an application has some

energy critical constraints.

SF_ReceiveMessage

Receives a frame from SIGFOX network using the

Receive_Frame command. Available for the

OL2385 device only

SF_TriggerWatchdog

Resets the SIGFOX device watchdog using the

Trigger_Watchdog command.

SF_GetDeviceInfo

Reads Device ID, PAC, SIGFOX library version and device version using the

Get_info and

Get_Device_Version commands

SF_GetState

Returns the current state of the SIGFOX device in the software state machine. The state is

updated every time an ACK SPI frame is received.

SF_GetErrorCode

Returns an error code received in a SPI frame from the SIGFOX device. The error code is updated

every time an ACK SPI frame is received.

SF_TestSpiCon

Tests if the SPI bus is working by using the

Echo command to send data (see SF_ECHO_DATA

macro) and then checking if the device replies with the inverted payload

SF_TestDevice

Executes a test of uplink and downlink connectivity using the

Send_Test_Mode command. The

returned status indicates the success or failure of the test. The user can obtain details using the

SF_Get_Error_Code function.

SF_GenerateContWave

Sends the

Continuous_Wave command to generate a continuous transmission at the last set

frequency. The signal can be then analyzed using a spectrum analyzer.

OL2385SWUG датащи(PDF) 25 Page - NXP Semiconductors

OL2385SWUG датащи(HTML) 25 Page - NXP Semiconductors

Html Pages

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64

датащи скачать

ссылки URL