Migration Guide#

This guide shows how to migrate projects from previous SDKs to a newer one.

RAIL SDK 2.18.0#

With the release of SiSDK-2024.12, the RAIL and Connect SDKs have been separated. The previously known FLEX SDK has been divided into two distinct software development kit: RAIL SDK and Connect SDK. The directory structure has been updated accordingly, with files moved from app/flex to app/rail and app/connect.

Additionally, component file names and APIs have been updated to reflect these changes. Any occurrence of the flex string in APIs or definitions has been updated to align with the new structure. The table below outlines the specific changes to file names and APIs:

Table of Changes#

Old File

New File

Changes

Details

simple_rail_assistance.h

sl_rail_sdk_simple_assistance.h

-

simple_rail_heartbeat.h

Deleted

-

simple_rail_rx.h

Deleted

-

simple_rail_rx_cli.h

Deleted

-

simple_rail_tx.h

Deleted

-

sl_flex_mode_switch.h

sl_rail_sdk_mode_switch.h

Rename API: prepare_package -> prepare_packet

sl_flex_ieee802154_support.h

sl_rail_sdk_ieee802154_support.h

Change part of names: FLEX -> RAIL_SDK , flex -> rail_sdk

sl_flex_rail_package_assistant.h

sl_rail_sdk_packet_assistant.h

Rename API: prepare_package -> prepare_packet

sl_flex_packet_asm.h

sl_rail_sdk_packet_asm.h

Change part of names: FLEX -> RAIL_SDK, flex -> rail_sdk

sl_flex_rail_sleep.h

sl_rail_sdk_sleep.h

Rename API: sl_flex_rail_sleep_init -> sl_rail_sdk_sleep_init

sl_flex_util_802154_init.h

sl_rail_sdk_util_802154_init.h

Change part of names: sl_flex_util_init -> sl_rail_sdk_util_init, sl_flex_util_get_handle -> sl_rail_sdk_util_get_handle

sl_flex_util_ble_init.h

sl_rail_sdk_util_ble_init.h

Change part of names: sl_flex_util_init -> sl_rail_sdk_util_init, sl_flex_util_get_handle -> sl_rail_sdk_util_get_handle

sl_flex_util_ble_protocol.h

sl_rail_sdk_util_ble_protocol.h

Rename include sl_flex_util_ble_protocol_config -> sl_rail_sdk_util_ble_protocol_config

sl_rail_simple_cpc.h

sl_rail_sdk_simple_cpc.h

Change part of names: rail -> rail_sdk

sl_wmbus_packet_assembler.h

sl_rail_sdk_wmbus_packet_assembler.h

Change part of names: wmbus -> rail_sdk_wmbus

sl_wmbus_sensor_pulse_counter.h

sl_rail_sdk_wmbus_sensor_core.h

Change part of names: wmbus -> rail_sdk_wmbus

sl_wmbus_sensor_pulse_counter.h

sl_rail_sdk_wmbus_sensor_pulse_counter.h

Change part of names: wmbus -> rail_sdk_wmbus

sl_wmbus_sensor_thermometer.h

sl_rail_sdk_wmbus_sensor_thermometer.h

Change part of names: wmbus -> rail_sdk_wmbus

sl_wmbus_sensor_virtual_water_meter.h

sl_rail_sdk_wmbus_sensor_virtual_water_meter.h

Change part of names: wmbus -> rail_sdk_wmbus