RobotLib  1
A set of software wrappers for Rovio, Roomba and NXT robots written in C#.
 All Classes Namespaces Functions Variables Enumerations Properties Pages
Public Member Functions | List of all members
Rovio.API.Network Class Reference

Network management. More...

Inheritance diagram for Rovio.API.Network:
Rovio.Component

Public Member Functions

 Network (Robot _robot)
 The constructor.
 
void SetIP (string value)
 Set IP settings.
 
string GetIP (string type)
 Get IP settings. Interface: eth1 wlan0
 
void SetWlan (string value)
 Set Wifi settings.
 
string GetWlan ()
 Get Wifi settings.
 
void SetDDNS (string value)
 Set dyndns.org service Service – DDNS service provider User – username Pass – password IP – IP address (null for auto detect) Proxy – name of the proxy ProxyPort – port of the proxy ProxyUser – username of the proxy ProxyPass – password of the proxy
 
string GetDDNS ()
 Get DDNS settings.
 
void SetMAC (string address)
 Set MAC address.
 
string GetMAC ()
 Get MAC address.
 
- Public Member Functions inherited from Rovio.Component
 Component (Robot _robot)
 The constructor.
 
virtual void Update ()
 The Update function that manually refreshes the state of a given component (e.g. when AutoUpdate = false)
 

Additional Inherited Members

- Public Attributes inherited from Rovio.Component
bool AutoUpdate = true
 Automatic update option for methods requesting more than one piece of information.
 
- Protected Attributes inherited from Rovio.Component
Robot robot
 The robot class, accessible by all dervied classes.
 

Detailed Description

Network management.

Constructor & Destructor Documentation

Rovio.API.Network.Network ( Robot  _robot)

The constructor.

Member Function Documentation

string Rovio.API.Network.GetDDNS ( )

Get DDNS settings.

Each line represents an item, and every item is in the format as Name = Value. ( Refer to SetDDNS.cgi) Return information represent by “Info” should be one of the following values: Updated Updating Failed Updating IP Checked Not Update

string Rovio.API.Network.GetIP ( string  type)

Get IP settings. Interface: eth1 wlan0

Todo:
Implement the enum input parameter.
string Rovio.API.Network.GetMAC ( )

Get MAC address.

string Rovio.API.Network.GetWlan ( )

Get Wifi settings.

void Rovio.API.Network.SetDDNS ( string  value)

Set dyndns.org service Service – DDNS service provider User – username Pass – password IP – IP address (null for auto detect) Proxy – name of the proxy ProxyPort – port of the proxy ProxyUser – username of the proxy ProxyPass – password of the proxy

Set the account for dyndns.org. To connect the dyndns server, if HTTP proxy is required, set the Proxy relative value, otherwise leave them blank. If sIPAddress is not set, the device will detect the IP address automatically.

Todo:
Fix the input parameter according to the following format: /SetDDNS.cgi?[Enable=<true|false>][Service=<dyndns|no-ip|dnsomatic>] [&User=sUsername][&Pass=sPassword][&DomainName=sDomainName][&IP=sIPAddress] [&Proxy=sProxyServer][&ProxyPort=iProxyServerPort][&ProxyUser=sProxyUsername] [&ProxyPass=sProxyPassword][&RedirectUrl=sUrl]
void Rovio.API.Network.SetIP ( string  value)

Set IP settings.

Todo:
Fix the input value according to the following format: /SetIP.cgi?[Interface=<eth1|wlan0>][&Enable=<true|false>][&IPWay=<manually|dhcp>][&CameraName=sName] [&IP=sIP][&Netmask=sNetmask][&Gateway=sGateway][&DNS0=sDNS0][&DNS1=sDNS1][&DNS2=sDNS2]
void Rovio.API.Network.SetMAC ( string  address)

Set MAC address.

void Rovio.API.Network.SetWlan ( string  value)

Set Wifi settings.

Todo:
Fix the input parameter according to the following format: /SetWlan.cgi?[Mode=<Managed|Ad-Hoc>][&Channel=sChannel] [&ESSID=sEssid][&WepSet=<Disable|K64|K128|ASC>] [&WepAsc=sWepAsc][&Wep64type=<Wep64HEX|Wep64ASC>][&Wep64=sWep64][&Wep128type=<Wep128HEX|Wep128ASC>][&Wep128=sWep128]

The documentation for this class was generated from the following file: