viam_sdk 0.0.2 copy "viam_sdk: ^0.0.2" to clipboard
viam_sdk: ^0.0.2 copied to clipboard

Viam Robotics Flutter SDK

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 the <LOCATION> and <SECRET> from app.viam.com
final options = RobotClientOptions.withLocationSecret('<SECRET>');
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