To execute tests on devices, partner has to configure device models and the device details in Automatics. 

Device Model Configuration

To execute tests on a new device model in Automatics, partner has to configure device model details in Device Manager, Automatics Orchestration and Automatics Properties.

The detailed steps of configuring device models in each component is given below.

1. Configure device model in Device Manager.

Devices to be used in the Automatics System should be configured in Device Manager. These devices are provided to Automatics Orchestration during test execution. Follow the  below steps to  add device details to the device manager database.

• Navigate to {protocol}://{host:port}/DeviceManager/swagger-ui.html.
• Navigate to Device Model API and execute   POST /deviceModel/add API to add new device model to the Application by providing "deviceModelId" and "deviceModelName" parameters.
• POST /deviceModel/add API will return response as "SUCCESS" on successfully adding the device model to the device manager database.
• Refer Device Manager API documentation- Device Model page to get more details on the parameters provided and type of responses received for  POST /deviceModel/add API.

2. Configure device model in Automatics Orchestration.

Automatics identifies a device model from its build name. For this, admin user has to configure device model and its corresponding build name. It requires only to map the device model and initial starting sub string of build name. The starting few letters(image prefix) in build name should be unique to a device model and this should be added in 'Image Name Prefix' text.

Steps to configure device model in Automatics Orchestration is available at Automatics Orchestration Configure Device Model.

3. Device model in Automatics Properties 

Partner has to configure model details in device_config.json deployed with Automatics Properties. The file can be found at VM where Automatics Properties is deployed at location {Apache_Tomcat_Home_Directory}/webapps/automatics/device_config.json.  Edit this file and add models details as shown below.

• For Raspberry Pi device with RDKB stack, update device_config.json as

{ 	
	"name":"Raspberry Pi-RDKB",
    "automaticsModelName": "Rpi-RDKB",
    "rackModelNames":["Rpi-RDKB"],
    "groups":[""],
    "category":"RDKB",
    "inventoryModelName":"Rpi-RDKB",
    "accessibleMechanism":"SSH",
    "accessbilityCheck": false,
    "waitTimeAfterHardReboot": 300000	
}

Device Configuration

1. Configure device details in Device Manager

Devices to be used in the Automatics System should be configured in Device Manager. These devices are provided to Automatics Orchestration during test execution. Follow the  below steps to  add device details to the device manager database. 

• Navigate to {protocol}://{host:port}/DeviceManager/swagger-ui.html.
• Navigate to Device API and try to execute   POST /device/add  API to adds new device to the Device Manager database by providing valid input parameters for deviceDetailsRequest as defined in Device Manager API Documentation#DeviceDetailsRequest.
• POST /deviceModel/add API will return response as "SUCCESS" on successfully adding the device details to the device manager database.G
• Refer Device Manager API Documentation#Device page to get more details on the parameters provided and type of responses received for  POST /device/add API.

2. Configure device group in Automatics Orchestration.

For Automatics to use devices from partner's inventory, device groups have to be configured. The device group name in inventory should be added here so that user can execute tests on devices within these groups only. Admin user can map device groups to users so that only those users mapped to device group can execute tests on device.

Steps to Configure device group in Automatics Orchestration is available at Automatics Orchestration Configure DeviceGroup.