| SerializerLibraryDocumentation |
Class Serializer
|
| Member | Description | |
|---|---|---|
![]() |
Constructor | Initializes a new instance of the Serializerclass. |
![]() |
CommunicationStarted | Occurs when communication with the serializer board has been established. |
![]() |
CommunicationStopped | Occurs when communication with the serializer board has been shutdown. |
![]() |
AsyncCallbacksEnabledDefault | The default value for the AsyncCallbacksEnabledproperty, which is set to false |
![]() |
BaudRateDefault | The default value for the BaudRateproperty, which is set to 19200. |
![]() |
PortNameDefault | The default value for the PortNameproperty, which is set to "COM1" |
![]() |
UnitsDefault | The default value for the Unitsproperty, which is Ids.Units.English. |
![]() |
BlinkLED | Blinks the specified LED, on the Serializer board, which is of type Ids.LedId public void BlinkLED(LedId led, int rate) |
![]() |
GetFirmwareVersion | Retrieve the firmware version string from the Serialzer board. public string GetFirmwareVersion(); |
![]() |
PumpEvents | Invokes all outstanding event callbacks on this thread. Does nothing if AsyncCallbacksEnabled is set to true. public void PumpEvents(); |
![]() |
Restore | Restores the Serializer to the default factory state. public void Restore(); |
![]() |
Run | Performs a serializer run loop for the calling thread. Communication with the serializer board is started and this thread is blocked until ShutDown() is called (presumably in an event handler). public void Run(); |
![]() |
ShutDown | Stop communication with the serializer board and cause the the run loop to be exited. public void ShutDown(); |
![]() |
StartCommunication | Starts communication with the Serializer board. All serializer componenets will now begin performing their tasks. public void StartCommunication(); |
![]() |
StopCommunication | Stops all communication with the Serializer board. All serializer componenets will now stop performing their tasks. public void StopCommunication(); |
![]() |
AsyncCallbacksEnabled | Enables asynchronous event callbacks. This allows events to be invoked on ThreadPool Threads. Otherwise they are queued internally until PumpEvents() is invoked directly or implicitly when using the Run() loop. |
![]() |
BaudRate | The baud rate of the serial port to use to communicate with the Serializer. |
![]() |
PortName | The name of the serial port to use to communicate with the Serializer. |
![]() |
Units | The units used to convert sensor readings (sonar, infrared, thermopile, etc.) queried on the Serializer. |