org.myrobotlab.service

Class VirtualDevice

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.service.VirtualDevice

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, PortListener, QueueReporter, SerialDataListener

public class VirtualDevice
extends Service
implements SerialDataListener

VirtualDevice - This is a virtual serial port device that can be used to redirect serial data over a network for example. Blender service requires this so the serial commands to an inmoov and be pumped over the network to blender, rather than over the serial port to an actual arduino.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	log

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
VirtualDevice(java.lang.String n)

Method Summary

Modifier and Type	Method and Description
void	clear()
SerialDevice	connectVirtualUart(java.lang.String myPort, java.lang.String uartPort)
void	createVirtualArduino(java.lang.String portName)
void	createVirtualSerial(java.lang.String portName)
SerialDevice	createVirtualUart()
Python	getLogic()
static ServiceType	getMetaData() This static method returns all the details of the class without it having to be constructed.
Message	getMsg(long timeout)
java.util.concurrent.BlockingQueue<Message>	getMsgs()
Serial	getUart(java.lang.String portName)
java.util.HashMap<java.lang.String,Serial>	getUarts()
static void	main(java.lang.String[] args)
java.lang.Integer	onByte(java.lang.Integer b)
void	onConnect(java.lang.String portName)
void	onDisconnect(java.lang.String portName)
boolean	preProcessHook(Message msg)
void	startService()
java.util.ArrayList<Message>	waitForMsgs(int count)
java.util.ArrayList<Message>	waitForMsgs(int count, int timeout)
java.util.ArrayList<Message>	waitForMsgs(int count, int timeout, int pollInterval)

Methods inherited from class org.myrobotlab.framework.Service

addListener, addListener, addTask, addTask, addTask, addTaskOneShot, allowDisplay, allowDisplay, attach, attach, broadcastState, buildDna, buildDna, buildDnaKeys, buildDnaNames, clearLastError, close, containsTask, copyShallowFrom, createPeer, createPeer, createRootReserved, detach, detach, detach, echoHeartbeat, error, error, error, getAttached, getCfgDir, getComm, getDeclaredMethodNames, getDeclaredMethods, getDescription, getDna, getDnaString, getHostName, getInbox, getInstanceId, getIntanceName, getInterfaceSet, getLastError, getMessageSet, getMetaData, getMethodMap, getMethodNames, getMethods, getMethodToolTip, getMsg, getName, getNotifyList, getNotifyListKeySet, getOutbox, getPeerKey, getPeerName, getServiceResourceFile, getSimpleName, getTasks, getThisThread, getType, hasError, hasPeers, help, help, in, info, info, invoke, invoke, invoke, invokeOn, isAttached, isAttached, isLocal, isReady, isRunning, isRuntime, isVirtual, load, load, logTimeEnable, mergeDna, mergeDna, mergePeerDna, movePeerDna, out, out, preRoutingHook, publishError, publishQueueStats, publishState, publishStats, publishStatus, purgeTask, purgeTasks, releasePeers, releaseService, removeAllListeners, removeListener, requiresSecurity, reserve, reserve, reserveRoot, reserveRoot, reserveRootAs, run, save, save, save, send, send, send, send, sendBlocking, sendBlocking, sendBlocking, sendBlocking, sendPeer, setInstanceId, setName, setPeer, setSecurityProvider, setState, setThisThread, setVirtual, sleep, stackToString, startHeartbeat, startPeer, startPeer, startRecording, stopHeartbeat, stopMsgRecording, stopService, subscribe, subscribe, subscribe, toString, unsubscribe, unsubscribe, unsubscribe, updateStats, warn, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.myrobotlab.service.interfaces.QueueReporter

publishStats, updateStats

Methods inherited from interface org.myrobotlab.framework.interfaces.NameProvider

getName

Field Detail

log

public static final org.slf4j.Logger log

Constructor Detail

VirtualDevice

public VirtualDevice(java.lang.String n)

Method Detail

startService

public void startService()

Specified by:

startService in interface ServiceInterface

Overrides:

startService in class Service

getLogic

public Python getLogic()

getUart

public Serial getUart(java.lang.String portName)

getUarts

public java.util.HashMap<java.lang.String,Serial> getUarts()

createVirtualSerial

public void createVirtualSerial(java.lang.String portName)
                         throws java.io.IOException

Throws:

java.io.IOException

createVirtualArduino

public void createVirtualArduino(java.lang.String portName)
                          throws java.io.IOException

Throws:

java.io.IOException

connectVirtualUart

public SerialDevice connectVirtualUart(java.lang.String myPort,
                                       java.lang.String uartPort)
                                throws java.io.IOException

Throws:

java.io.IOException

createVirtualUart

public SerialDevice createVirtualUart()
                               throws java.io.IOException

Throws:

java.io.IOException

onByte

public java.lang.Integer onByte(java.lang.Integer b)
                         throws java.io.IOException

Specified by:

onByte in interface SerialDataListener

Throws:

java.io.IOException

onConnect

public void onConnect(java.lang.String portName)

Specified by:

onConnect in interface PortListener

onDisconnect

public void onDisconnect(java.lang.String portName)

Specified by:

onDisconnect in interface PortListener

preProcessHook

public boolean preProcessHook(Message msg)

Overrides:

preProcessHook in class Service

clear

public void clear()

getMsgs

public java.util.concurrent.BlockingQueue<Message> getMsgs()

getMsg

public Message getMsg(long timeout)
               throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

waitForMsgs

public java.util.ArrayList<Message> waitForMsgs(int count)
                                         throws java.lang.InterruptedException,
                                                java.io.IOException

Throws:

java.lang.InterruptedException

java.io.IOException

waitForMsgs

public java.util.ArrayList<Message> waitForMsgs(int count,
                                                int timeout)
                                         throws java.lang.InterruptedException,
                                                java.io.IOException

Throws:

java.lang.InterruptedException

java.io.IOException

waitForMsgs

public java.util.ArrayList<Message> waitForMsgs(int count,
                                                int timeout,
                                                int pollInterval)
                                         throws java.lang.InterruptedException,
                                                java.io.IOException

Throws:

java.lang.InterruptedException

java.io.IOException

getMetaData

public static ServiceType getMetaData()

This static method returns all the details of the class without it having to be constructed. It has description, categories, dependencies, and peer definitions.

Returns:

ServiceType - returns all the data

main

public static void main(java.lang.String[] args)