@dronedeploy/rocos-js-sdk 0.0.1 → 2.6.1

package/services/RobotService.d.ts

@@ -0,0 +1,282 @@
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IRobot } from '../models/IRobot';
+import { IRobotTemplate } from '../models/IRobotTemplate';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class RobotService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Get a list of robots.
+     *
+     * @param projectId - Project Id
+     */
+    getRobots(projectId: string): Promise<IRobot[]>;
+    /**
+     * Create a new robot.
+     *
+     * @param projectId
+     * @param robot - Robot payload {@link IRobot}
+     */
+    create(projectId: string, robot: IRobot): Promise<any>;
+    /**
+     * Update robot information.
+     *
+     * @param projectId Project Id
+     * @param robot - Robot payload {@link IRobot}
+     */
+    update(projectId: string, robot: IRobot): Promise<any>;
+    /**
+     * Delete the robots by callsign list
+     *
+     * @param projectId - Project Id
+     * @param callsignIds - Callsign list
+     */
+    delete(projectId: string, callsignIds: string[]): Promise<any>;
+    /**
+     * Get robot information by project id and callsign of the robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Callsign of the robot
+     */
+    info(projectId: string, callsign: string): Promise<IRobot>;
+    /**
+     * Get robot information by project id and callsign of the robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Callsign of the robot
+     */
+    attributes(projectId: string, callsign: string): Promise<Record<string, string>>;
+    /**
+     * Register the specified callsign
+     *
+     * @param projectId - Project Id
+     * @param callsign - Callsign of the robot
+     */
+    register(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Robot Templates
+     */
+    templates(): Promise<IRobotTemplate[]>;
+    /**
+     * Get the deployment details of virtual robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Virtual Robot Callsign
+     */
+    virtualRobotDeploymentDetails(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Deploy a virtual robot by project id and callsign
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot's Callsign
+     */
+    deployVirtualRobot(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Get data sources tree components JSON schema
+     */
+    dataSourcesSchema(): Promise<any>;
+    /**
+     * Delete a robot dashboard.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     * @param dashboardId - Dashboard Id
+     */
+    deleteRobotDashboardsV2(projectId: string, callsign: string, dashboardId: string): Promise<any>;
+    /**
+     * Delete a profile dashboard.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     * @param dashboardId - Dashboard Id
+     */
+    deleteDashboardsV2(projectId: string, profileId: string, dashboardId: string): Promise<any>;
+    /**
+     * Get a list of robot dashboards.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     */
+    listRobotDashboardsV2(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Get a list of profile dashboards.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     */
+    listDashboardsV2(projectId: string, profileId: string): Promise<any>;
+    /**
+     * Get a profile dashboard.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     * @param dashboardId - Dashboard Id
+     */
+    robotDefDashboardsV2(projectId: string, profileId: string, dashboardId: string): Promise<any>;
+    /**
+     * Get Dashboard data which stored in Azure Blob.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     * @param dashboardId - Dashboard Id
+     */
+    robotDefDashboardBlobV2(projectId: string, profileId: string, dashboardId: string): Promise<any>;
+    /**
+     * Create dashboard for a robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     * @param model - Payload
+     */
+    createRobotDashboardsV2(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Create dashboard for a profile.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     * @param model - Payload
+     */
+    createDashboardsV2(projectId: string, profileId: string, model: any): Promise<any>;
+    /**
+     * Update dashboard for a profile.
+     *
+     * @param projectId - Project Id
+     * @param profileId - Profile Id
+     * @param dashboardId - Dashboard Id
+     * @param model - Payload
+     */
+    robotDefUpdateDashboardsV2(projectId: string, profileId: string, dashboardId: string, model: any): Promise<any>;
+    /**
+     * Get a list of dashboard for a robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     * @param dashboardId - Dashboard Id
+     */
+    getDashboardsV2(projectId: string, callsign: string, dashboardId: string): Promise<any>;
+    /**
+     * Get robot dashboard which stored in Azure Blob.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     * @param dashboardId - Dashboard Id
+     */
+    getDashboardBlobV2(projectId: string, callsign: string, dashboardId: string): Promise<any>;
+    /**
+     * Update dashboard for a robot.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot Callsign
+     * @param dashboardId - Dashboard Id
+     * @param model - Payload
+     */
+    updateDashboardsV2(projectId: string, callsign: string, dashboardId: string, model: any): Promise<any>;
+    /**
+     * Get robot settings
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getSettings(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update robot settings.
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateSettings(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get agent settings for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getAgentSettings(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update agent settings for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateAgentSettings(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get commands for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getCommands(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update commands for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateCommands(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get command V2 for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getCommandsV2(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update command V2 for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateCommandsV2(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get buttons for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getButtons(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update buttons for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateButtons(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get triggers for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getTriggers(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update triggers for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - Payload
+     */
+    updateTriggers(projectId: string, callsign: string, model: any): Promise<any>;
+    /**
+     * Get gamepads for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getGamepads(projectId: string, callsign: string): Promise<any>;
+    /**
+     * Update gamepads for a robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     * @param model - \payload
+     */
+    updateGamepads(projectId: string, callsign: string, model: any): Promise<any>;
+}