This document provides a brief description of the STM Template OpEN APIs. It provides the following services:
- Gets current active Template Id.
- Sets active template id.
- Get the first valid template ID.
- Get the next valid template ID.
- Gets name and description of specific template id
- Sets(Revert to) Default template.
Example C Application stm template_example
Initialization
In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.
stm template_example
template_example.c is a sample application that demonstrates the use of OpEN's STM Template APIs. stm template_example is started from the command line and can be used to exercise the various APIs by specifying arguments on the command line.
Sample Output
- Usage: ./stm template_example <test#> <arg1> <arg2> ...
- Test 1: Gets current active Template Id: stm template_example 1 <templateId>
- Test 2: Sets active template id: stm template_example 2 <templateId>
- Test 3: Get the first valid template ID: stm template_example 3 <firstTemplateId>
- Test 4: Get the next valid template ID: stm template_example 4 <currentTemplateId><nextTemplateId>
- Test 5: Gets name and description of specific template id: stm template_example 5 <templateId><templateName><templateDesc>
- Test 6: Sets(Revert to) Default template: stm template_example 6
- Test 7: Run API sanity checks: stm template_example 7
STM Template CLI/API Cross Reference
openapiStmNextTemplateIdGet()
openapiStmTemplateNameDescriptionGet() (config) sdm prefer | openapiStmActiveTemplateIdSet
