Viam Flutter SDK

Build and connect to robots with Flutter

build status license

(In)stability Notice

Warning This is a beta release of the Viam Flutter SDK. No guarantees are made to the stability of the API. All changes will be enumerated in the release notes.

Getting started

Make sure your project meets the minimum requirements:

  • Minimum iOS target: 13.0
  • Minimum Android SDK: 23

Installation

flutter pub add viam_sdk

Usage

You can use the Viam SDK to connect to an existing robot (to create a robot, view the documentation or try Viam).

import 'package:viam_sdk/viam_sdk.dart';

// Connect to an existing robot
// *NOTE* Get '<API KEY ID>' and '<API KEY>' from app.viam.com
final options = RobotClientOptions.withAPIKey('<API KEY ID>', '<API KEY>');
final robot = await RobotClient.atAddress('<LOCATION>', options);

// Print the available resources
print(robot.resourceNames);

// Access a component
final movementSensor = MovementSensor.fromRobot(robot, 'my_sensor');
print(await movementSensor.readings())

Example app

View the sample app in the /example directory to see a more in-depth example.

License

Copyright 2021-2023 Viam Inc.

Apache 2.0 - See LICENSE file

Libraries

base
board
button
camera_stream
gripper
joystick
motor
multi_camera_stream
sensor
viam_sdk
Robots at your fingertips.
widgets

Protobuf Definitions

viam_protos.app.app Protobuf Definitions
The proto definitions for app
viam_protos.app.billing Protobuf Definitions
The proto definitions for billing
viam_protos.app.cloud_slam Protobuf Definitions
The proto definitions for cloud_slam
viam_protos.app.data Protobuf Definitions
The proto definitions for data
viam_protos.app.data_sync Protobuf Definitions
The proto definitions for data_sync
viam_protos.app.ml_training Protobuf Definitions
The proto definitions for ml_training
viam_protos.app.packages Protobuf Definitions
The proto definitions for packages
viam_protos.app.robot Protobuf Definitions
The proto definitions for robot
viam_protos.common.common Protobuf Definitions
The proto definitions for common
viam_protos.component.arm Protobuf Definitions
The proto definitions for arm
viam_protos.component.audioinput Protobuf Definitions
The proto definitions for audioinput
viam_protos.component.base Protobuf Definitions
The proto definitions for base
viam_protos.component.board Protobuf Definitions
The proto definitions for board
viam_protos.component.camera Protobuf Definitions
The proto definitions for camera
viam_protos.component.encoder Protobuf Definitions
The proto definitions for encoder
viam_protos.component.gantry Protobuf Definitions
The proto definitions for gantry
viam_protos.component.generic Protobuf Definitions
The proto definitions for generic
viam_protos.component.gripper Protobuf Definitions
The proto definitions for gripper
viam_protos.component.input_controller Protobuf Definitions
The proto definitions for input_controller
viam_protos.component.motor Protobuf Definitions
The proto definitions for motor
viam_protos.component.movementsensor Protobuf Definitions
The proto definitions for movementsensor
viam_protos.component.pose_tracker Protobuf Definitions
The proto definitions for pose_tracker
viam_protos.component.powersensor Protobuf Definitions
The proto definitions for powersensor
viam_protos.component.sensor Protobuf Definitions
The proto definitions for sensor
viam_protos.component.servo Protobuf Definitions
The proto definitions for servo
viam_protos.component.testecho Protobuf Definitions
The proto definitions for testecho
viam_protos.module.module Protobuf Definitions
The proto definitions for module
viam_protos.robot.robot Protobuf Definitions
The proto definitions for robot
viam_protos.service.data_manager Protobuf Definitions
The proto definitions for data_manager
viam_protos.service.mlmodel Protobuf Definitions
The proto definitions for mlmodel
viam_protos.service.motion Protobuf Definitions
The proto definitions for motion
viam_protos.service.navigation Protobuf Definitions
The proto definitions for navigation
viam_protos.service.sensors Protobuf Definitions
The proto definitions for sensors
viam_protos.service.shell Protobuf Definitions
The proto definitions for shell
viam_protos.service.slam Protobuf Definitions
The proto definitions for slam
viam_protos.service.vision Protobuf Definitions
The proto definitions for vision