diff --git a/src/components/input-controller/input-controller.ts b/src/components/input-controller/input-controller.ts index 6a6378839..92088a7aa 100644 --- a/src/components/input-controller/input-controller.ts +++ b/src/components/input-controller/input-controller.ts @@ -25,6 +25,9 @@ export interface InputController extends Resource { * const recentEvents = await controller.getEvents(); * console.log('Recent events:', recentEvents); * ``` + * + * For more information, see [Input Controller + * API](https://docs.viam.com/dev/reference/apis/components/input-controller/#getevents). */ getEvents(extra?: Struct): Promise; @@ -51,6 +54,9 @@ export interface InputController extends Resource { * // Trigger the event * await controller.triggerEvent(buttonPressEvent); * ``` + * + * For more information, see [Input Controller + * API](https://docs.viam.com/dev/reference/apis/components/input-controller/#triggerevent). */ triggerEvent(event: InputControllerEvent, extra?: Struct): Promise; } diff --git a/src/components/motor/motor.ts b/src/components/motor/motor.ts index d4b746987..05f7908e8 100644 --- a/src/components/motor/motor.ts +++ b/src/components/motor/motor.ts @@ -20,6 +20,9 @@ export interface Motor extends Resource { * await motor.setPower(0.4); * ``` * + * For more information, see [Motor + * API](https://docs.viam.com/dev/reference/apis/components/motor/#setpower). + * * @param power - A value between -1 and 1 where negative values indicate a * backwards direction and positive values a forward direction. */ @@ -39,6 +42,9 @@ export interface Motor extends Resource { * await motor.goFor(60, 7.2); * ``` * + * For more information, see [Motor + * API](https://docs.viam.com/dev/reference/apis/components/motor/#gofor). + * * @param rpm - Speed in revolutions per minute. * @param revolutions - Number of revolutions relative to the motor's starting * position. If this value is 0, this will run the motor at the given rpm @@ -60,6 +66,9 @@ export interface Motor extends Resource { * await motor.goTo(75, 8.3); * ``` * + * For more information, see [Motor + * API](https://docs.viam.com/dev/reference/apis/components/motor/#goto). + * * @param rpm - Speed in revolutions per minute. * @param positionRevolutions - Number of revolutions relative to the motor's * home position. @@ -79,6 +88,9 @@ export interface Motor extends Resource { * await motor.setRPM(75); * ``` * + * For more information, see [Motor + * API](https://docs.viam.com/dev/reference/apis/components/motor/#setrpm). + * * @param rpm - Speed in revolutions per minute. */ setRPM(rpm: number, extra?: Struct): Promise; @@ -96,6 +108,9 @@ export interface Motor extends Resource { * await motor.resetZeroPosition(0.0); * ``` * + * For more information, see [Motor + * API](https://docs.viam.com/dev/reference/apis/components/motor/#resetzeroposition). + * * @param offset - Position from which to offset the current position. */ resetZeroPosition(offset: number, extra?: Struct): Promise; @@ -111,6 +126,9 @@ export interface Motor extends Resource { * // Stop the motor * await motor.stop(); * ``` + * + * For more information, see [Motor + * API](https://docs.viam.com/dev/reference/apis/components/motor/#stop). */ stop(extra?: Struct): Promise; @@ -127,6 +145,9 @@ export interface Motor extends Resource { * const properties = await motor.getProperties(); * console.log('Properties:', properties); * ``` + * + * For more information, see [Motor + * API](https://docs.viam.com/dev/reference/apis/components/motor/#getproperties). */ getProperties(extra?: Struct): Promise; @@ -143,6 +164,9 @@ export interface Motor extends Resource { * const position = await motor.getPosition(); * console.log('Position:', position); * ``` + * + * For more information, see [Motor + * API](https://docs.viam.com/dev/reference/apis/components/motor/#getposition). */ getPosition(extra?: Struct): Promise; @@ -159,6 +183,9 @@ export interface Motor extends Resource { * console.log('Powered:', isPowered); * console.log('Power percentage:', powerPct); * ``` + * + * For more information, see [Motor + * API](https://docs.viam.com/dev/reference/apis/components/motor/#ispowered). */ isPowered(extra?: Struct): Promise; @@ -174,6 +201,9 @@ export interface Motor extends Resource { * const moving = await motor.isMoving(); * console.log('Moving:', moving); * ``` + * + * For more information, see [Motor + * API](https://docs.viam.com/dev/reference/apis/components/motor/#ismoving). */ isMoving(): Promise; } diff --git a/src/components/movement-sensor/movement-sensor.ts b/src/components/movement-sensor/movement-sensor.ts index 2a8afdec9..8bf610627 100644 --- a/src/components/movement-sensor/movement-sensor.ts +++ b/src/components/movement-sensor/movement-sensor.ts @@ -30,6 +30,9 @@ export interface MovementSensor extends Resource { * ); * const linearVelocity = await movementSensor.getLinearVelocity(); * ``` + * + * For more information, see [Movement Sensor + * API](https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getlinearvelocity). */ getLinearVelocity(extra?: Struct): Promise; @@ -45,6 +48,9 @@ export interface MovementSensor extends Resource { * ); * const angularVelocity = await movementSensor.getAngularVelocity(); * ``` + * + * For more information, see [Movement Sensor + * API](https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getangularvelocity). */ getAngularVelocity(extra?: Struct): Promise; @@ -61,6 +67,9 @@ export interface MovementSensor extends Resource { * ); * const compassHeading = await movementSensor.getCompassHeading(); * ``` + * + * For more information, see [Movement Sensor + * API](https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getcompassheading). */ getCompassHeading(extra?: Struct): Promise; @@ -76,6 +85,9 @@ export interface MovementSensor extends Resource { * ); * const orientation = await movementSensor.getOrientation(); * ``` + * + * For more information, see [Movement Sensor + * API](https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getorientation). */ getOrientation(extra?: Struct): Promise; @@ -91,6 +103,9 @@ export interface MovementSensor extends Resource { * ); * const position = await movementSensor.getPosition(); * ``` + * + * For more information, see [Movement Sensor + * API](https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getposition). */ getPosition(extra?: Struct): Promise; @@ -106,6 +121,9 @@ export interface MovementSensor extends Resource { * ); * const properties = await movementSensor.getProperties(); * ``` + * + * For more information, see [Movement Sensor + * API](https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getproperties). */ getProperties(extra?: Struct): Promise; @@ -121,6 +139,9 @@ export interface MovementSensor extends Resource { * ); * const accuracy = await movementSensor.getAccuracy(); * ``` + * + * For more information, see [Movement Sensor + * API](https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getaccuracy). */ getAccuracy(extra?: Struct): Promise; @@ -137,6 +158,9 @@ export interface MovementSensor extends Resource { * const linearAcceleration = * await movementSensor.getLinearAcceleration(); * ``` + * + * For more information, see [Movement Sensor + * API](https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getlinearacceleration). */ getLinearAcceleration(extra?: Struct): Promise; @@ -152,6 +176,9 @@ export interface MovementSensor extends Resource { * ); * const readings = await movementSensor.getReadings(); * ``` + * + * For more information, see [Movement Sensor + * API](https://docs.viam.com/dev/reference/apis/components/movement-sensor/#getreadings). */ getReadings(extra?: Struct): Promise>; } diff --git a/src/components/power-sensor/power-sensor.ts b/src/components/power-sensor/power-sensor.ts index 0d08c2d1b..353a2fbec 100644 --- a/src/components/power-sensor/power-sensor.ts +++ b/src/components/power-sensor/power-sensor.ts @@ -16,6 +16,9 @@ export interface PowerSensor extends Sensor { * ); * const [voltage, isAc] = await powerSensor.getVoltage(); * ``` + * + * For more information, see [Power Sensor + * API](https://docs.viam.com/dev/reference/apis/components/power-sensor/#getvoltage). */ getVoltage(extra?: Struct): Promise; /** @@ -31,6 +34,9 @@ export interface PowerSensor extends Sensor { * ); * const [current, isAc] = await powerSensor.getCurrent(); * ``` + * + * For more information, see [Power Sensor + * API](https://docs.viam.com/dev/reference/apis/components/power-sensor/#getcurrent). */ getCurrent(extra?: Struct): Promise; /** @@ -45,6 +51,9 @@ export interface PowerSensor extends Sensor { * ); * const power = await powerSensor.getPower(); * ``` + * + * For more information, see [Power Sensor + * API](https://docs.viam.com/dev/reference/apis/components/power-sensor/#getpower). */ getPower(extra?: Struct): Promise; /** @@ -59,6 +68,9 @@ export interface PowerSensor extends Sensor { * ); * const readings = await powerSensor.getReadings(); * ``` + * + * For more information, see [Power Sensor + * API](https://docs.viam.com/dev/reference/apis/components/power-sensor/#getreadings). */ getReadings(extra?: Struct): Promise>; } diff --git a/src/components/sensor/sensor.ts b/src/components/sensor/sensor.ts index e3d7c3938..392e9789e 100644 --- a/src/components/sensor/sensor.ts +++ b/src/components/sensor/sensor.ts @@ -14,6 +14,9 @@ export interface Sensor extends Resource { * // Get the readings of a sensor. * const readings = await sensor.getReadings(); * ``` + * + * For more information, see [Sensor + * API](https://docs.viam.com/dev/reference/apis/components/sensor/#getreadings). */ getReadings(extra?: Struct): Promise>; } diff --git a/src/components/servo/servo.ts b/src/components/servo/servo.ts index 1fbd74ccb..117fe08ed 100644 --- a/src/components/servo/servo.ts +++ b/src/components/servo/servo.ts @@ -17,6 +17,9 @@ export interface Servo extends Resource { * // Move the servo from its origin to the desired angle of 90 degrees * await servo.move(90); * ``` + * + * For more information, see [Servo + * API](https://docs.viam.com/dev/reference/apis/components/servo/#move). */ move(angleDeg: number, extra?: Struct): Promise; @@ -31,6 +34,9 @@ export interface Servo extends Resource { * // Get the current set angle of the servo * const pos = await servo.getPosition(); * ``` + * + * For more information, see [Servo + * API](https://docs.viam.com/dev/reference/apis/components/servo/#getposition). */ getPosition(extra?: Struct): Promise; @@ -48,6 +54,9 @@ export interface Servo extends Resource { * // Stop the servo. It is assumed that the servo stops moving immediately * await servo.stop(); * ``` + * + * For more information, see [Servo + * API](https://docs.viam.com/dev/reference/apis/components/servo/#stop). */ stop(extra?: Struct): Promise; @@ -62,6 +71,9 @@ export interface Servo extends Resource { * const moving = await servo.isMoving(); * console.log('Moving:', moving); * ``` + * + * For more information, see [Servo + * API](https://docs.viam.com/dev/reference/apis/components/servo/#ismoving). */ isMoving(): Promise; } diff --git a/src/components/switch/switch.ts b/src/components/switch/switch.ts index 47af02c62..79cd0e0a9 100644 --- a/src/components/switch/switch.ts +++ b/src/components/switch/switch.ts @@ -17,6 +17,9 @@ export interface Switch extends Resource { * // Update the switch from its current position to position 0 * await mySwitch.setPosition(0); * ``` + * + * For more information, see [Switch + * API](https://docs.viam.com/dev/reference/apis/components/switch/#setposition). */ setPosition: (position: number, extra?: Struct) => Promise; @@ -40,6 +43,9 @@ export interface Switch extends Resource { * // Get the current set position * const pos2 = await mySwitch.getPosition(); * ``` + * + * For more information, see [Switch + * API](https://docs.viam.com/dev/reference/apis/components/switch/#getposition). */ getPosition: (extra?: Struct) => Promise; @@ -55,6 +61,9 @@ export interface Switch extends Resource { * const numPositions = await mySwitch.getNumberOfPositions(); * console.log('Number of positions:', numPositions); * ``` + * + * For more information, see [Switch + * API](https://docs.viam.com/dev/reference/apis/components/switch/#getnumberofpositions). */ getNumberOfPositions: (extra?: Struct) => Promise; } diff --git a/src/services/vision/vision.ts b/src/services/vision/vision.ts index 3ca6da348..815c658fd 100644 --- a/src/services/vision/vision.ts +++ b/src/services/vision/vision.ts @@ -22,6 +22,9 @@ export interface Vision extends Resource { * const detections = await vision.getDetectionsFromCamera('my_camera'); * ``` * + * For more information, see [Vision + * API](https://docs.viam.com/dev/reference/apis/services/vision/#getdetectionsfromcamera). + * * @param cameraName - The name of the camera to use for detection. * @returns - The list of Detections. */ @@ -49,6 +52,9 @@ export interface Vision extends Resource { * ); * ``` * + * For more information, see [Vision + * API](https://docs.viam.com/dev/reference/apis/services/vision/#getdetections). + * * @param image - The image from which to get detections. * @param width - The width of the image. * @param height - The height of the image. @@ -76,6 +82,9 @@ export interface Vision extends Resource { * ); * ``` * + * For more information, see [Vision + * API](https://docs.viam.com/dev/reference/apis/services/vision/#getclassificationsfromcamera). + * * @param cameraName - The name of the camera to use for classification. * @param count - The number of Classifications requested. * @returns - The list of Classifications. @@ -106,6 +115,9 @@ export interface Vision extends Resource { * ); * ``` * + * For more information, see [Vision + * API](https://docs.viam.com/dev/reference/apis/services/vision/#getclassifications). + * * @param image - The image from which to get classifications. * @param width - The width of the image. * @param height - The height of the image. @@ -134,6 +146,9 @@ export interface Vision extends Resource { * await vision.getObjectPointClouds('my_camera'); * ``` * + * For more information, see [Vision + * API](https://docs.viam.com/dev/reference/apis/services/vision/#getobjectpointclouds). + * * @param cameraName - The name of the camera. * @returns - The list of PointCloudObjects */ @@ -154,6 +169,9 @@ export interface Vision extends Resource { * const properties = await vision.getProperties(); * ``` * + * For more information, see [Vision + * API](https://docs.viam.com/dev/reference/apis/services/vision/#getproperties). + * * @returns - The properties of the vision service */ getProperties: (extra?: Struct) => Promise; @@ -174,6 +192,9 @@ export interface Vision extends Resource { * }); * ``` * + * For more information, see [Vision + * API](https://docs.viam.com/dev/reference/apis/services/vision/#captureallfromcamera). + * * @param cameraName - The name of the camera to use for classification, * detection, and segmentation. * @param opts - The fields desired in the response.