Routing Management and XRM Examples

Ucs_Rm_SetRouteActive Example

// Main function
void main(uint8_t argc, char *argv[])
{
    // ...

    (void)Ucs_Rm_SetRouteActive(running_inst_ptr, &route_66, true);

    // ...

    (void)Ucs_Rm_SetRouteActive(running_inst_ptr, &route_66, false);

}

Ucs_Rm_GetNodeAvailable Example

// Main function
void main(uint8_t argc, char *argv[])
{
    // ...
    if (Ucs_Rm_GetNodeAvailable(ucs_inst_ptr, slim_mic_node.signature_ptr->node_address))
    {
        // Do whatever is necessary to be done
    }
}

Ucs_Rm_GetConnectionLabel Example

// Main function
void main()
{
   // ...

   // Retrieve "ConnectionLabel" of route_66.
   if (is_route66_built)
   {
       connection_label = Ucs_Rm_GetConnectionLabel(ucs_inst_ptr, &route_66);
   }

   // ...

}

Ucs_Xrm_Stream_SetPortConfig

// Main function
void main()
{
    // ...

    Ucs_Xrm_Stream_SetPortConfig(ucs_inst_ptr,
                               0x555U,
                               0x0U,
                               UCS_STREAM_PORT_OP_MODE_GENERIC,
                               UCS_STREAM_PORT_OPT_IN_OUT,
                               UCS_STREAM_PORT_CLK_MODE_OUTPUT,
                               UCS_STREAM_PORT_CLK_DLY_NONE,
                               &App_XrmStreamPortCfgResCb);
    // ...

}

// The streaming port result callback function
static void App_XrmStreamPortCfgResCb(uint16_t node_address,
                                      uint8_t index,
                                      Ucs_Stream_PortOpMode_t op_mode,
                                      Ucs_Stream_PortOption_t port_option,
                                      Ucs_Stream_PortClockMode_t clock_mode,
                                      Ucs_Stream_PortClockDataDelay_t clock_data_delay,
                                      Ucs_StdResult_t result,
                                      void *user_ptr)
{
    if (result.code != UCS_RES_SUCCESS)
    {
        // Do whatever is necessary here...
    }
}

Ucs_Xrm_Stream_GetPortConfig

// Main function
void main()
{
   (void)Ucs_Xrm_Stream_GetPortConfig(ucs_inst_ptr, 0x555U, 0x0U, &App_XrmStreamPortCfgResCb);
}

// The streaming port result callback function
static void App_XrmStreamPortCfgResCb(uint16_t node_address,
                                      uint8_t index,
                                      Ucs_Stream_PortOpMode_t op_mode,
                                      Ucs_Stream_PortOption_t port_option,
                                      Ucs_Stream_PortClockMode_t clock_mode,
                                      Ucs_Stream_PortClockDataDelay_t clock_data_delay,
                                      Ucs_StdResult_t result,
                                      void *user_ptr)
{
    if (result.code == UCS_RES_SUCCESS)
    {
        // Read Streaming ports configuration here...
    }
}