Class NavigationClient

constructor

• new NavigationClient(
      client: RobotClient,
      name: string,
      options?: Options,
  ): NavigationClient

  Parameters

  • client: RobotClient
  • name: string
  • options: Options = {}

  Returns NavigationClient

callOptions

Readonlyname

addWayPoint

• addWayPoint(
      location: PlainMessage,
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<void>

  Add a waypoint to the service's data storage.

  Parameters

  • location: PlainMessage

    The current location of the robot n the navigation service with latitude and longitude values.
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>

doCommand

• doCommand(command: Struct, callOptions?: CallOptions): Promise<JsonValue>

  Send/Receive arbitrary commands to the resource.

  Parameters

  • command: Struct

    The command to execute.
  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

  Example

  const result = await resource.doCommand({
    name: 'myCommand',
    args: { key: 'value' },
  });
  Copy

getLocation

• getLocation(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<navigationApi.GetLocationResponse>

  Get the current location of the robot.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<navigationApi.GetLocationResponse>

getMode

• getMode(extra?: {}, callOptions?: CallOptions): Promise<navigationApi.Mode>

  Get the mode the robot is operating in.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<navigationApi.Mode>

getObstacles

• getObstacles(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<commonApi.GeoGeometry[]>

  Get a list of obstacles.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<commonApi.GeoGeometry[]>

getPaths

• getPaths(extra?: {}, callOptions?: CallOptions): Promise<navigationApi.Path[]>

  Gets the list of paths known to the navigation service.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<navigationApi.Path[]>

getProperties

• getProperties(
      callOptions?: CallOptions,
  ): Promise<navigationApi.GetPropertiesResponse>

  Gets information on the properties of the current navigation service.

  Parameters

  • callOptions: CallOptions = ...

  Returns Promise<navigationApi.GetPropertiesResponse>

getWayPoints

• getWayPoints(
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<navigationApi.Waypoint[]>

  Get an array of waypoints currently in the service's data storage.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<navigationApi.Waypoint[]>

removeWayPoint

• removeWayPoint(id: string, extra?: {}, callOptions?: CallOptions): Promise<void>

  Remove a waypoint from the service's data storage.

  Parameters

  • id: string

    The MongoDB ObjectID of the waypoint to remove from the service's data storage.
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>

setMode

• setMode(
      mode: navigationApi.Mode,
      extra?: {},
      callOptions?: CallOptions,
  ): Promise<void>

  Set the mode the robot is operating in.

  Parameters

  • mode: navigationApi.Mode

    The mode for the service to operate in.
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>