API  2.3.0
TSmarT Software Library
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions

Functions

int8_t TSMART_SIGFOX_TD_Init (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Initialization of the Sigfox TD device. More...
 
int8_t TSMART_SIGFOX_TD_CheckDevice (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Checks device. More...
 
int8_t TSMART_SIGFOX_TD_ConfigureDevice (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Configures the Sigfox TD device. More...
 
int8_t TSMART_SIGFOX_TD_LanFrequency (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint32_t TSMART_SIGFOX_TD_frequency)
 Sets the LAN frequency. More...
 
int8_t TSMART_SIGFOX_TD_LanAddress (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint32_t TSMART_SIGFOX_TD_address)
 Configures the TD LAN address. More...
 
int8_t TSMART_SIGFOX_TD_LanMask (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint32_t TSMART_SIGFOX_TD_mask)
 Configures the TD LAN address mask. More...
 
int8_t TSMART_SIGFOX_TD_LanPower (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, int8_t TSMART_SIGFOX_TD_dbm_level)
 Configures the TD LAN RF power level in dBm. More...
 
int8_t TSMART_SIGFOX_TD_SendCommand (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, tsmart_sigfox_td_command_t TSMART_SIGFOX_TD_command, uint8_t *TSMART_SIGFOX_TD_answer)
 Sends a command. More...
 
int8_t TSMART_SIGFOX_TD_SaveConfiguration (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Saves the active configuration into a non volatile memory (Flash). More...
 
int8_t TSMART_SIGFOX_TD_RestoreFactorySettings (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Restores factory settings from Flash memory. More...
 
int8_t TSMART_SIGFOX_TD_DefaultConfiguration (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Restores the default configuration profile from non-volatile memory (Flash). More...
 
int8_t TSMART_SIGFOX_TD_SfKeepAliveS300 (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_period)
 Configures or disables the SIGFOX keepalive RF messages period. More...
 
int8_t TSMART_SIGFOX_TD_SfKeepAliveS301 (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_repeats)
 Configures or disables the SIGFOX keepalive RF messages number of repeats. More...
 
int8_t TSMART_SIGFOX_TD_SfPowerS302 (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_dbm_level)
 Configures the SIGFOX RF power level in dBm. More...
 
int8_t TSMART_SIGFOX_TD_SensorModuleType (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_type)
 Configures the TD SENSOR module type. More...
 
int8_t TSMART_SIGFOX_TD_SensorDeviceClass (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint16_t TSMART_SIGFOX_TD_class)
 Configures the TD SENSOR Device Class. More...
 
int8_t TSMART_SIGFOX_TD_SensorBatteryMonitoring (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_enable, uint16_t TSMART_SIGFOX_TD_level_low, uint16_t TSMART_SIGFOX_TD_level_ok)
 Configures the TD SENSOR battery monitoring status. More...
 
int8_t TSMART_SIGFOX_TD_SensorTemperatureMonitoring (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_enable, uint32_t TSMART_SIGFOX_TD_interval, int8_t TSMART_SIGFOX_TD_level_low, int8_t TSMART_SIGFOX_TD_level_high)
 Configures the TD SENSOR temperature monitoring status. More...
 
int8_t TSMART_SIGFOX_TD_SensorConnectionMonitoring (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_enable, uint32_t TSMART_SIGFOX_TD_interval)
 Configures the TD SENSOR Connection monitoring status. More...
 
int8_t TSMART_SIGFOX_TD_SensorBootMonitoring (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_enable)
 Configures the TD SENSOR boot monitoring status. More...
 
int8_t TSMART_SIGFOX_TD_SensorKeepAliveMonitoring (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_enable, uint8_t TSMART_SIGFOX_TD_interval)
 Configures the TD SENSOR Keep-Alive monitoring status. More...
 
int8_t TSMART_SIGFOX_TD_SensorOpenRegistration (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_enable)
 Enables or disables Devices registration on the Gateway. More...
 
int8_t TSMART_SIGFOX_TD_SensorRegistration (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Allows a Device to register on the Gateway. More...
 
int8_t TSMART_SIGFOX_TD_SensorStartReception (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_enable)
 Start reception on gateway. More...
 
int8_t TSMART_SIGFOX_TD_SensorGetAddress (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint32_t *TSMART_SIGFOX_TD_addr, uint32_t *TSMART_SIGFOX_TD_mask)
 Displays current address and mask values for Sensor LAN. More...
 
int8_t TSMART_SIGFOX_TD_SensorLanReset (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Resets the current LAN address. More...
 
int8_t TSMART_SIGFOX_TD_SensorEventBoot (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Sends a Sensor message indicating a Boot Event. More...
 
int8_t TSMART_SIGFOX_TD_SensorEventConnection (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_entry_id, uint8_t TSMART_SIGFOX_TD_status)
 Sends a Sensor message indicating a Connection Lost or Connection OK Event for a given device in a LAN. More...
 
int8_t TSMART_SIGFOX_TD_SensorEventRssi (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_entry_id, uint8_t TSMART_SIGFOX_TD_status)
 This function sends a Sensor message indicating a RSSI Level Low or RSSI Level OK Event for a given device in a LAN. More...
 
int8_t TSMART_SIGFOX_TD_SensorEventTemperature (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_status)
 Sends a Sensor message indicating a Temperature Level Low, Temperature Level OK or Temperature Level High Event. More...
 
int8_t TSMART_SIGFOX_TD_SensorEventBattery (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_status)
 Sends a Sensor message indicating a Battery Level Low, Battery Level OK Event. More...
 
int8_t TSMART_SIGFOX_TD_SensorEventKeepAlive (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Sends a Sensor message indicating a Keep-Alive Event. More...
 
int8_t TSMART_SIGFOX_TD_SensorEventRegister (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Allows registering a device on Sensor. More...
 
void TSMART_SIGFOX_TD_ResetHw (tsmart_sigfox_td_t *TSMART_SIGFOX_TD)
 Resets a Sigfox TD device. More...
 
int8_t TSMART_SIGFOX_TD_SfSendRfMesssage (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t *TSMART_SIGFOX_TD_payload, uint8_t TSMART_SIGFOX_TD_payload_size)
 Sends a SIGFOX RF message. More...
 
int8_t TSMART_SIGFOX_TD_SfSendRfTestMesssage (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint16_t TSMART_SIGFOX_TD_count, int8_t TSMART_SIGFOX_TD_period, int16_t TSMART_SIGFOX_TD_channel, uint32_t TSMART_SIGFOX_TD_timeout)
 Sends a SIGFOX test RF message. More...
 
int8_t TSMART_SIGFOX_TD_SensorSendRawMesssage (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t *TSMART_SIGFOX_TD_payload, uint8_t TSMART_SIGFOX_TD_payload_size)
 Sends a Raw Sensor Message. More...
 
int8_t TSMART_SIGFOX_TD_SensorLanSendDataToGw (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t *TSMART_SIGFOX_TD_payload, uint8_t TSMART_SIGFOX_TD_payload_size)
 Sends a LAN RF message. More...
 
int8_t TSMART_SIGFOX_TD_LanSendRfMesssage (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t *TSMART_SIGFOX_TD_payload, uint8_t TSMART_SIGFOX_TD_payload_size)
 Sends a LAN RF message. More...
 
int8_t TSMART_SIGFOX_TD_LanReceiveRfMesssage (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_mode, uint32_t TSMART_SIGFOX_TD_timeout, uint8_t *TSMART_SIGFOX_TD_payload)
 Disables/Enables a TD LAN RF message. More...
 
int8_t TSMART_SIGFOX_TD_SensorDataPhone (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_index, uint8_t *TSMART_SIGFOX_TD_phone_number)
 Data Phone. More...
 
int8_t TSMART_SIGFOX_TD_SensorServiceSms (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t *TSMART_SIGFOX_TD_message)
 Sends an SMS. More...
 
int8_t TSMART_SIGFOX_TD_SensorRssiMonitoring (tsmart_sigfox_td_t *TSMART_SIGFOX_TD, uint8_t TSMART_SIGFOX_TD_enable, int8_t TSMART_SIGFOX_TD_level_low, int8_t TSMART_SIGFOX_TD_level_ok)
 Configures the TD SENSOR RSSI monitoring status. More...
 

Detailed Description

Function Documentation

int8_t TSMART_SIGFOX_TD_CheckDevice ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Checks device.

This function checks if the device is working properly or not.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
Returns
  • TSMART_PASS - Device is OK.
  • TSMART_FAIL - Device is not working properly.
Examples:
sigfox_td.c.
int8_t TSMART_SIGFOX_TD_ConfigureDevice ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Configures the Sigfox TD device.

Before any communication, users shall execute this function to set up the basic configuration to be ready for any other operation.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
Examples:
sigfox_td.c.
int8_t TSMART_SIGFOX_TD_DefaultConfiguration ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Restores the default configuration profile from non-volatile memory (Flash).

Note
: As a Telecom Design extension, this function also resets the Sigfox device to its power-on state.
Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure
int8_t TSMART_SIGFOX_TD_Init ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Initialization of the Sigfox TD device.

Initializes the hardware configuration of the Sigfox TD device and the associated OS mechanisms.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
Returns
  • TSMART_PASS - OK
  • TSMART_FAIL - Not possible to get software resources (queues, mutext and so on).
Examples:
sigfox_td.c.
int8_t TSMART_SIGFOX_TD_LanAddress ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint32_t  TSMART_SIGFOX_TD_address 
)

Configures the TD LAN address.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_addressNetwork address. Range: 0 to 16777215.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_LanFrequency ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint32_t  TSMART_SIGFOX_TD_frequency 
)

Sets the LAN frequency.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_frequencyWorking frequency. Range: 868000000...869700000 (Hz).
Returns
  • TSMART_PASS - OK
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_LanMask ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint32_t  TSMART_SIGFOX_TD_mask 
)

Configures the TD LAN address mask.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_maskNetwork address. Range: 0 to 16777215.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_LanPower ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
int8_t  TSMART_SIGFOX_TD_dbm_level 
)

Configures the TD LAN RF power level in dBm.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_dbm_levelNetwork address. Range: -35 to 14 (in dBm).
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_LanReceiveRfMesssage ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_mode,
uint32_t  TSMART_SIGFOX_TD_timeout,
uint8_t *  TSMART_SIGFOX_TD_payload 
)

Disables/Enables a TD LAN RF message.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_modeTD LAN Receive RF Message Mode Parameter.
  • 0 - Disable TD LAN RF receive mode.
  • 1 - Enable TD LAN RF synchronous single-frame receive mode, either infinite or until a timeout value is reached.
  • 2 - Enable TD LAN RF asynchronous multi-frame receive mode.
TSMART_SIGFOX_TD_timeoutMaximum waiting timeout to receive a message in seconds(paramter valid for mode 1 and 2).
TSMART_SIGFOX_TD_payloadPayload received(output paramter valid for mode 1 and 2).
Returns
  • TSMART_PASS - OK.
  • TSMART_SIGFOX_TD_FAULT_CODE_1 - Set reception mode fails.
  • TSMART_SIGFOX_TD_FAULT_CODE_2 - Bad reception.
  • TSMART_FAIL - Mode is not valid.
int8_t TSMART_SIGFOX_TD_LanSendRfMesssage ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t *  TSMART_SIGFOX_TD_payload,
uint8_t  TSMART_SIGFOX_TD_payload_size 
)

Sends a LAN RF message.

The actual length of the sent message is always 17-byte long.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_payloadPayload. Range: 1 to 17 bytes.
TSMART_SIGFOX_TD_payload_sizePayload size.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
void TSMART_SIGFOX_TD_ResetHw ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Resets a Sigfox TD device.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
int8_t TSMART_SIGFOX_TD_RestoreFactorySettings ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Restores factory settings from Flash memory.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SaveConfiguration ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Saves the active configuration into a non volatile memory (Flash).

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SendCommand ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
tsmart_sigfox_td_command_t  TSMART_SIGFOX_TD_command,
uint8_t *  TSMART_SIGFOX_TD_answer 
)

Sends a command.

This function sends a predefinited command to read some interesting parameters of the device such as FW version or serial number.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_commandCommand to be send.
TSMART_SIGFOX_TD_answerPointer to answer command buffer.
Returns
  • TSMART_PASS - Device is OK.
  • TSMART_FAIL - Device is not working properly.
Examples:
sigfox_td.c.
int8_t TSMART_SIGFOX_TD_SensorBatteryMonitoring ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_enable,
uint16_t  TSMART_SIGFOX_TD_level_low,
uint16_t  TSMART_SIGFOX_TD_level_ok 
)

Configures the TD SENSOR battery monitoring status.

If the Battery level falls below the specified level, a Battery Low Event will be emitted. If the Battery level rises above the specified level, a Battery OK Event will be emitted.

Note
That a Battery OK Event will only be emitted if a Battery Low Event occurred previously.
Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_enableTD SENSOR Battery Monitoring Enable Parameter. 0 Disable, 1 Enable.
TSMART_SIGFOX_TD_level_lowTD SENSOR Battery Monitoring Level Low Parameter. Battery Low Level in millivolts. Range: 2100 to 3300.
TSMART_SIGFOX_TD_level_okTD SENSOR Battery Monitoring Level OK Parameter. Battery OK Level in millivolts. Range: 2100 to 3300.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorBootMonitoring ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_enable 
)

Configures the TD SENSOR boot monitoring status.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_enableTD SENSOR Boot Monitoring Enable Parameter. 0 Disable, 1 enable.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorConnectionMonitoring ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_enable,
uint32_t  TSMART_SIGFOX_TD_interval 
)

Configures the TD SENSOR Connection monitoring status.

Module Type must be set to Device to use this functionality. Connection monitoring requires the device to communicate with a Gateway. Therefore a Gateway or a Transmitter cannot monitor its own connection status. Hence to activate connection monitoring the Module type must be set to Device.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_enableTD SENSOR Connection Monitoring Enable Parameter. 0 Disable, 1 Enable.
TSMART_SIGFOX_TD_intervalTD SENSOR Connection Monitoring Interval Parameter. Connection checking interval in seconds. Due to transmission duration and risks of collisions the minimum checking interval is 10s. Minimum recommended interval when monitoring connection for several devices is 300 seconds. Range: 10 to 4294967295.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorDataPhone ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_index,
uint8_t *  TSMART_SIGFOX_TD_phone_number 
)

Data Phone.

This function sends a Sensor message containing a phone number. If the Module Type is set to Device, then a Local Register and a Sensor Register functions must have previously been issued for the message to be received. It the Module type is set to either Gateway or Transmitter a Sensor Register functions must have previously been issued for the message to be received

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_indexPhone number index. Can be used to save several phone numbers (0 to 4).
TSMART_SIGFOX_TD_phone_numberCell Phone number up to 18 digits (leading zeros excluded).
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorDeviceClass ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint16_t  TSMART_SIGFOX_TD_class 
)

Configures the TD SENSOR Device Class.

It allows differentiating several kinds of modules.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_classTD SENSOR Class Parameter. Range: 0 to 65535.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorEventBattery ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_status 
)

Sends a Sensor message indicating a Battery Level Low, Battery Level OK Event.

If the Module Type is set to Device, then a Local Register and a Sensor Register function must have previously been executed for the message to be received.

It the Module type is set to either Gateway or Transmitter a Sensor Register function must have previously been executed for the message to be received.

Please keep in mind that this function is provided for event simulation only. Event messages should be sent automatically if the corresponding monitoring is enabled. Please do not send any Event message in your application.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_statusSENSOR Send Event Battery Status Parameter. 0 Battery Low Event, 1 Battery OK Event.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorEventBoot ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Sends a Sensor message indicating a Boot Event.

If the Module Type is set to Device, then a Local Register and a Sensor Register function must have previously been executed for the message to be received. It the Module type is set to either Gateway or Transmitter a Sensor Register function must have previously been executed for the message to be received.

Please keep in mind that this function is provided for event simulation only. Event messages should be sent automatically if the corresponding monitoring is enabled. Please do not send any Event message in your application.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure
int8_t TSMART_SIGFOX_TD_SensorEventConnection ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_entry_id,
uint8_t  TSMART_SIGFOX_TD_status 
)

Sends a Sensor message indicating a Connection Lost or Connection OK Event for a given device in a LAN.

If the Module Type is set to Device, then a Local Register and a Sensor Register function must have previously been executed for the message to be received. It the Module type is set to either Gateway or Transmitter a Sensor Register function must have previously been executed for the message to be received.

Please keep in mind that this command is provided for event simulation only. Event messages should be sent automatically if the corresponding monitoring is enabled. Please do not send any Event message in your application.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_entry_idSENSOR Send Event Connection Entry ID Parameter. Address of the concerned device in the LAN. Note that address 0 being reserved to the gateway it cannot be used for sending a Connection Event. Range: 1 to 15.
TSMART_SIGFOX_TD_statusSENSOR Send Event Connection Status Parameter. 0 Connection Lost Event. 1 Connection OK Event.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorEventKeepAlive ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Sends a Sensor message indicating a Keep-Alive Event.

If the Module Type is set to Device, then a Local Register and a Sensor Register function must have previously been executed for the message to be received. It the Module type is set to either Gateway or Transmitter a Sensor Register function must have previously been executed for the message to be received.

Please keep in mind that this function is provided for event simulation only. Event messages should be sent automatically if the corresponding monitoring is enabled. Please do not send any Event message in your application.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorEventRegister ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Allows registering a device on Sensor.

This function must be executed once prior any other function in order to ensure proper message processing for the SIGFOX™-compatible functions implemented.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorEventRssi ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_entry_id,
uint8_t  TSMART_SIGFOX_TD_status 
)

This function sends a Sensor message indicating a RSSI Level Low or RSSI Level OK Event for a given device in a LAN.

If the Module Type is set to Device, then a Local Register and a Sensor Register function must have previously been executed for the message to be received. It the Module type is set to either Gateway or Transmitter a Sensor Register function must have previously been executed for the message to be received. Please keep in mind that this function is provided for event simulation only. Event messages should be sent automatically if the corresponding monitoring is enabled. Please do not send any Event message in your application.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_entry_idSENSOR Send Event RSSI Entry ID Parameter. Address of the concerned device in the LAN. Note that address 0 being reserved to the gateway it cannot be used for sending a RSSI Event.
TSMART_SIGFOX_TD_statusSENSOR Send Event RSSI Status Parameter. 0 RSSI Level Low Event or 1 RSSI Level OK Event.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorEventTemperature ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_status 
)

Sends a Sensor message indicating a Temperature Level Low, Temperature Level OK or Temperature Level High Event.

If the Module Type is set to Device, then a Local Register and a Sensor Register function must have previously been executed for the message to be received. It the Module type is set to either Gateway or Transmitter a Sensor Register function must have previously been executed for the message to be received.

Please keep in mind that this command is provided for event simulation only. Event messages should be sent automatically if the corresponding monitoring is enabled. Please do not send any Event message in your application.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_statusSENSOR Send Event Temperature Status Parameter. 0 Temperature Low Event. 1 Temperature OK Event. 2 Temperature High Event.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorGetAddress ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint32_t *  TSMART_SIGFOX_TD_addr,
uint32_t *  TSMART_SIGFOX_TD_mask 
)

Displays current address and mask values for Sensor LAN.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_addrAddress (output paramter).
TSMART_SIGFOX_TD_maskMask (outout parameter).
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorKeepAliveMonitoring ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_enable,
uint8_t  TSMART_SIGFOX_TD_interval 
)

Configures the TD SENSOR Keep-Alive monitoring status.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_enableTD SENSOR Keep-Alive Monitoring Enable Parameter. 0 disable, 1 enable.
TSMART_SIGFOX_TD_intervalTD SENSOR Keep-Alive Monitoring Interval Parameter. Keep-Alive monitoring interval in hours. A Keep-alive Sensor frame will be sent every interval if enable is set to 1. Range: 1 to 255.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorLanReset ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Resets the current LAN address.

The Module type shall be set to Device. If the Module type is set to Gateway, this function resets the list of Devices connected to the gateway.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure
int8_t TSMART_SIGFOX_TD_SensorLanSendDataToGw ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t *  TSMART_SIGFOX_TD_payload,
uint8_t  TSMART_SIGFOX_TD_payload_size 
)

Sends a LAN RF message.

This function sends a Data Message to the Gateway. Module type must be set to Device and a Local Register must have previously been issued for this function to be successful.

The maximum payload to be sent is 16 bytes.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_payloadPayload. Range: 1 to 16 bytes.
TSMART_SIGFOX_TD_payload_sizePayload size.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorModuleType ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_type 
)

Configures the TD SENSOR module type.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_typeDevice: 0, Gateway: 1, Transmitter: 2
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorOpenRegistration ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_enable 
)

Enables or disables Devices registration on the Gateway.

Module type must be set to Gateway to execute this function. A maximum of 15 Devices can register on a unique Gateway.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_enableSENSOR LAN Open Registration Enable Parameter.0 Disable, 1 Enable.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorRegistration ( tsmart_sigfox_td_t TSMART_SIGFOX_TD)

Allows a Device to register on the Gateway.

Module type must be set to Device to execute this function. Any Device must first register to the Gateway to obtain a LAN address and be able to send messages to Sensor.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorRssiMonitoring ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_enable,
int8_t  TSMART_SIGFOX_TD_level_low,
int8_t  TSMART_SIGFOX_TD_level_ok 
)

Configures the TD SENSOR RSSI monitoring status.

Module Type must be set to device and keep-alive monitoring must be enabled to use this functionality. If the RSSI level falls below the specified level, a RSSI Low Event will be emitted.

RSSI monitoring requires the device to communicate with a Gateway. Therefore a Gateway or a Transmitter cannot monitor its own RSSI status. Hence to activate RSSI monitoring the Module type must be set to Device. Moreover RSSI status is only checked when a Gateway receives a message from a Device. Checking RSSI level at regular interval requires then to communicate with the Gateway at the very same interval (whichever the message type is). We therefore also require having Keep-Alive monitoring enabled in order to monitor RSSI.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_enableTD SENSOR RSSI Monitoring Enable Parameter. 0 disable RSSI Monitoring, 1 enable RSSI Monitoring.
TSMART_SIGFOX_TD_level_lowTD SENSOR RSSI Monitoring Level Low Parameter. RSSI Low Level in dBm. Range: -122 to 14.
TSMART_SIGFOX_TD_level_okTD SENSOR RSSI Monitoring Level High Parameter. RSSI OK Level in dBm. Range:-122 to 14.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorSendRawMesssage ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t *  TSMART_SIGFOX_TD_payload,
uint8_t  TSMART_SIGFOX_TD_payload_size 
)

Sends a Raw Sensor Message.

The maximum payload to be sent is 10 bytes.

If the Module Type is set to Device, then a Local Register and a Sensor Register function must have previously been issued for the message to be received. It the Module type is set to either Gateway or Transmitter a Sensor Register function must have previously been issued for the message to be received.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_payloadPayload. Range: 1 to 10 bytes.
TSMART_SIGFOX_TD_payload_sizePayload size.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorServiceSms ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t *  TSMART_SIGFOX_TD_message 
)

Sends an SMS.

This function sends an SMS to a pre-registered cell-phone number (either via the Sensor Web Interface or the Data Phone Message). If the Module Type is set to Device, then a Local Register and a Sensor Register function must have previously been issued for the message to be received. It the Module type is set to either Gateway or Transmitter a Sensor Register function must have previously been issued for the message to be received.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_messageASCII Message, up to 9 characters. Note that commas cannot be sent using this function.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorStartReception ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_enable 
)

Start reception on gateway.

This function starts reception LAN messages on gateway.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_enableSENSOR LAN start reception enable Parameter. 0 Disable, 1 Enable.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SensorTemperatureMonitoring ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_enable,
uint32_t  TSMART_SIGFOX_TD_interval,
int8_t  TSMART_SIGFOX_TD_level_low,
int8_t  TSMART_SIGFOX_TD_level_high 
)

Configures the TD SENSOR temperature monitoring status.

If the Temperature level falls below the specified level, a Temperature Low Event will be emitted. If the Temperature level rises above the specified level, a Temperature High Event will be emitted.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_enableEnable(1)/disable(0) temperature monitoring.
TSMART_SIGFOX_TD_intervalTD SENSOR Temperature Monitoring Interval Parameter. Interval in seconds at which the Temperature should be checked. Range: 0 to 4294967295 in seconds.
TSMART_SIGFOX_TD_level_lowTD SENSOR Temperature Monitoring Level Low Parameter. Temperature Low Level in Celsius degrees. Range:
TSMART_SIGFOX_TD_level_highTD SENSOR Temperature Monitoring Level High Parameter. Temperature High Level in Celsius degrees.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
int8_t TSMART_SIGFOX_TD_SfKeepAliveS300 ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_period 
)

Configures or disables the SIGFOX keepalive RF messages period.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_periodSIGFOX Keepalive Period Parameter.Range: 0 to 127(hours). If 0, SIGFOX keepalive RF messages are disabled.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
Examples:
sigfox_td.c.
int8_t TSMART_SIGFOX_TD_SfKeepAliveS301 ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_repeats 
)

Configures or disables the SIGFOX keepalive RF messages number of repeats.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_repeatsSIGFOX Keepalive Repeat Parameter.Range: 0 to 2(retires). If 0, SIGFOX keepalive RF messages retries are disabled.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
Examples:
sigfox_td.c.
int8_t TSMART_SIGFOX_TD_SfPowerS302 ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t  TSMART_SIGFOX_TD_dbm_level 
)

Configures the SIGFOX RF power level in dBm.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_dbm_levelSIGFOX RF power level. Range: 0 to 14 in dBm.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
Examples:
sigfox_td.c.
int8_t TSMART_SIGFOX_TD_SfSendRfMesssage ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint8_t *  TSMART_SIGFOX_TD_payload,
uint8_t  TSMART_SIGFOX_TD_payload_size 
)

Sends a SIGFOX RF message.

The maximum payload to be sent is 12 bytes.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_payloadPayload. Range: 1 to 12 bytes.
TSMART_SIGFOX_TD_payload_sizePayload size.
Note
If the message length is greater than 1 and is odd, a null padding byte is appended at the end of the message.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
Examples:
sigfox_td.c.
int8_t TSMART_SIGFOX_TD_SfSendRfTestMesssage ( tsmart_sigfox_td_t TSMART_SIGFOX_TD,
uint16_t  TSMART_SIGFOX_TD_count,
int8_t  TSMART_SIGFOX_TD_period,
int16_t  TSMART_SIGFOX_TD_channel,
uint32_t  TSMART_SIGFOX_TD_timeout 
)

Sends a SIGFOX test RF message.

This function sends the number of messages selected and after that it returns. The more messages you send the more time it will require to send them.

Parameters
TSMART_SIGFOX_TDSigfox TD structure handler pointer.
TSMART_SIGFOX_TD_countCount of SIGFOX test RF messages. Range: 0 to 65535.
TSMART_SIGFOX_TD_periodPeriod in seconds between SIGFOX test RF messages. ange: 1 to 255.
TSMART_SIGFOX_TD_channelTest Message Channel Parameter. When (-1) it uses an automatic channel selection. On other hand, channels have a fixed 100 Hz bandwidth, starting at 868.180 MHz for channel 0, ending at 868.198 Mhz for channel 180, restarting at 868.202 MHz for channel 220 and ending at 868.220 MHz for channel 400. Range: 0 to 180 or 220 to 400.
TSMART_SIGFOX_TD_timeoutMaximum waiting timeout in ms.
Returns
  • TSMART_PASS - OK.
  • TSMART_FAIL - Failure.
Examples:
sigfox_td.c.