RF Test#

The RF Test component provides low-level APIs to produce an RF tone or a modulated packet. The RF Test component cannot run simultaneously with the Wi-SUN stack and is only meant for production calibration.

Functions#

sl_status_t
sl_wisun_start_stream(uint16_t channel)

Start transmitting a random stream of characters to enable the measurement of radio modulation.

sl_status_t

Stop a previously started stream of characters.

sl_status_t
sl_wisun_start_tone(uint16_t channel)

Start transmitting an unmodulated tone.

sl_status_t

Stop a previously started tone.

sl_status_t

Set transmit power.

bool

Return the current status of the RF test plugin.

Function Documentation#

sl_wisun_start_stream#

sl_status_t sl_wisun_start_stream (uint16_t channel)

Start transmitting a random stream of characters to enable the measurement of radio modulation.

Parameters
[in]channel

Name of the Wi-SUN network as a zero-terminated string

Transmit a PN9 bytes sequence. See RAIL_StartTxStream for more information.

Returns

  • One of the following:

    • SL_STATUS_OK if the stream transmission started successfully.

    • SL_STATUS_NOT_READY if called before the stack initialization.

    • SL_STATUS_BUSY if a test is already running.

    • SL_STATUS_NETWORK_UP if a connection is already established or in progress.

    • SL_STATUS_INVALID_PARAMETER if an invalid channel is configured.


Definition at line 55 of file /mnt/raid/workspaces/ws.zJeaRLJo0/overlay/super/protocol/wisun/wisun/inc/sl_wisun_rf_test.h

sl_wisun_stop_stream#

sl_status_t sl_wisun_stop_stream ()

Stop a previously started stream of characters.

Parameters
[in]channel

Name of the Wi-SUN network as a zero-terminated string

See RAIL_StopTxStream for more information.

Returns

  • One of the following:

    • SL_STATUS_OK if the stream transmission stopped successfully.

    • SL_STATUS_INVALID_STATE if while not transmitting a stream.


Definition at line 68 of file /mnt/raid/workspaces/ws.zJeaRLJo0/overlay/super/protocol/wisun/wisun/inc/sl_wisun_rf_test.h

sl_wisun_start_tone#

sl_status_t sl_wisun_start_tone (uint16_t channel)

Start transmitting an unmodulated tone.

Parameters
[in]channel

Name of the Wi-SUN network as a zero-terminated string

Transmit a PN9 bytes sequence. See RAIL_StartTxStream for more information.

Returns

  • One of the following:

    • SL_STATUS_OK if the stream transmission started successfully.

    • SL_STATUS_NOT_READY if called before the stack initialization.

    • SL_STATUS_BUSY if a test is already running.

    • SL_STATUS_NETWORK_UP if a connection is already established or in progress.

    • SL_STATUS_INVALID_PARAMETER if an invalid channel is configured.


Definition at line 84 of file /mnt/raid/workspaces/ws.zJeaRLJo0/overlay/super/protocol/wisun/wisun/inc/sl_wisun_rf_test.h

sl_wisun_stop_tone#

sl_status_t sl_wisun_stop_tone ()

Stop a previously started tone.

Parameters
[in]channel

Name of the Wi-SUN network as a zero-terminated string

See RAIL_StopTxStream for more information.

Returns

  • One of the following:

    • SL_STATUS_OK if the tone stopped successfully.

    • SL_STATUS_INVALID_STATE if while not transmitting a tone.


Definition at line 96 of file /mnt/raid/workspaces/ws.zJeaRLJo0/overlay/super/protocol/wisun/wisun/inc/sl_wisun_rf_test.h

sl_wisun_set_test_tx_power#

sl_status_t sl_wisun_set_test_tx_power (int8_t tx_power)

Set transmit power.

Parameters
[in]tx_power

Transmit power in units of dBm, can be negative.

Returns

  • always SL_STATUS_OK


Definition at line 105 of file /mnt/raid/workspaces/ws.zJeaRLJo0/overlay/super/protocol/wisun/wisun/inc/sl_wisun_rf_test.h

sl_wisun_is_running_rf_test#

bool sl_wisun_is_running_rf_test ()

Return the current status of the RF test plugin.

Returns

  • One of the following:

    • True if a test is running.

    • False otherwise.


Definition at line 114 of file /mnt/raid/workspaces/ws.zJeaRLJo0/overlay/super/protocol/wisun/wisun/inc/sl_wisun_rf_test.h