Class RobotConfiguration

The robot configuration information

Inheritance

Object

RobotObject

RobotConfiguration

Implements

INotifyPropertyChanged

IRobotConfiguration

IRemoteRobotConfiguration

Inherited Members

RobotObject.PropertyChanged

Namespace: Anki.Vector

Assembly: Anki.Vector.dll

Syntax

public class RobotConfiguration : RobotObject, INotifyPropertyChanged, IRobotConfiguration, IRemoteRobotConfiguration

Properties

Certificate

Gets or sets the certificate.

public string Certificate { get; set; }

Property Type

String

Guid

Gets or sets the unique identifier.

public string Guid { get; set; }

Property Type

String

HasRemoteHost

Gets a value indicating whether this instance has remote host.

public bool HasRemoteHost { get; }

Property Type

Boolean

IPAddress

Gets or sets the IP address of the robot

public IPAddress IPAddress { get; set; }

Property Type

IPAddress

RemoteHost

Gets or sets the remote vector host name and optional port.

public string RemoteHost { get; set; }

Property Type

String

RobotName

Gets or sets the name of the robot. This is in the form "Vector-XXXX"

public string RobotName { get; set; }

Property Type

String

SerialNumber

Gets or sets the robot serial number.

public string SerialNumber { get; set; }

Property Type

String

Methods

AddOrUpdate(RobotConfiguration)

Adds the specified robot configuration to the configuration file using the default SDK configuration file path.

The robot configuration is appended if new or updated if already exists

public static void AddOrUpdate(RobotConfiguration robot)

Parameters

Type	Name	Description
RobotConfiguration	robot	The robot.

AddOrUpdate(String, RobotConfiguration)

Adds the specified robot configuration to the configuration file using the specified SDK configuration file path.

The robot configuration is appended if new or updated if already exists

public static void AddOrUpdate(string sdkConfigFilePath, RobotConfiguration robot)

Parameters

Type	Name	Description
String	sdkConfigFilePath	The SDK configuration file path.
RobotConfiguration	robot	The robot configuration.

Load()

Loads the configuration file using the default SDK configuration file path.

public static IEnumerable<RobotConfiguration> Load()

Returns

Type	Description
IEnumerable<RobotConfiguration>	Robot configurations

Load(String)

Loads the configuration file using the specified SDK configuration file path.

public static IEnumerable<RobotConfiguration> Load(string sdkConfigFilePath)

Parameters

Type	Name	Description
String	sdkConfigFilePath	The SDK configuration file path.

Returns

Type	Description
IEnumerable<RobotConfiguration>	Robot configurations

LoadDefault()

Loads the first configuration entry from the default configuration file.

public static RobotConfiguration LoadDefault()

Returns

Type	Description
RobotConfiguration	Robot configuration

Save(IEnumerable<RobotConfiguration>)

Stores the specified robot configurations using the default SDK configuration file path.

Any robot configurations not in the list will be removed.

public static void Save(IEnumerable<RobotConfiguration> robots)

Parameters

Type	Name	Description
IEnumerable<RobotConfiguration>	robots	The robot configurations.

Save(String, IEnumerable<RobotConfiguration>)

Stores the specified robot configurations using the specified SDK configuration file path.

Any robot configurations not in the list will be removed.

public static void Save(string sdkConfigFilePath, IEnumerable<RobotConfiguration> robots)

Parameters

Type	Name	Description
String	sdkConfigFilePath	The SDK configuration file path.
IEnumerable<RobotConfiguration>	robots	The robots configurations.

Implements

System.ComponentModel.INotifyPropertyChanged

IRobotConfiguration

IRemoteRobotConfiguration

Extension Methods

Authentication.TryValidate(IRobotConfiguration)

Authentication.Validate(IRobotConfiguration)

Authentication.FindRobotAddress(IRobotConfiguration)

See Also

IRobotConfiguration