Class for detecting an arduino and sending commands to it More...

Public Member Functions
	ArduinoCommands (int baudRate, string portString="")
	Initializes a new instance of the ArduinoCommands class. More...

string	FindComPort ()
	Finds the COM port used by arduino More...

void	ActivateLaser (bool on=true)
	Activates the laser. More...

void	ActivateLight (bool on, int hue)
	Activates the light. More...

void	RotateTurnTableCw (int steps)
	Rotates the turn table clockwise. More...

void	RotateTurnTableCcw (int steps)
	Rotates the turn table counter clockwise. More...

void	RotateLaserCw (int steps)
	Rotates the laser clockwise. More...

void	RotateLaserCcw (int steps)
	Rotates the laser counter clockwise. More...

void	EnableMicroStepping ()
	Enables the micro stepping. More...

void	DisableMicroStepping ()
	Disables the micro stepping. More...

Properties
bool	PortFound `[get]`
	Gets a value indicating whether [port found]. More...

string	PortString `[get]`
	Gets the port string. More...

Detailed Description

Class for detecting an arduino and sending commands to it

Definition at line 13 of file ArduinoCommands.cs.

Constructor & Destructor Documentation

ArduinoConnection.ArduinoCommands.ArduinoCommands	(	int	baudRate,
		string	portString = `""`
	)

Initializes a new instance of the ArduinoCommands class.

Parameters

baudRate	The baud rate.
portString	Th port string.

Definition at line 42 of file ArduinoCommands.cs.

         {
             Singleton<Logger>.Instance.LogInfo($"Starting arduino connection with baudrate:{baudRate}");
 
             this.baudRate = baudRate;
             if (String.IsNullOrEmpty(portString))
                 this.FindComPort();
             else
             {
                 this.PortString = portString;
                 this.currentPort = new SerialPort(this.PortString, baudRate) {ReadTimeout = 2000};
             }
 
             if (null != this.currentPort)
                 this.currentPort.ErrorReceived += this.CurrentPortOnErrorReceived;
             
         }

Here is the call graph for this function:

Member Function Documentation

void ArduinoConnection.ArduinoCommands.ActivateLaser ( bool on = true )

Activates the laser.

Parameters

on	if set to `true` [on].

Definition at line 132 of file ArduinoCommands.cs.

         {
             this.SendCommand(@on
                 ? CommandRepresentations.EnableLaserCommand
                 : CommandRepresentations.DisableLaserCommand);
         }

Here is the caller graph for this function:

void ArduinoConnection.ArduinoCommands.ActivateLight	(	bool	on,
		int	hue
	)

Activates the light.

Parameters

on	if set to `true` [on].
hue	The hue.

Definition at line 145 of file ArduinoCommands.cs.

         {
             if (on)
                 this.SendCommand(CommandRepresentations.EnableLightCommand, hue);
             else
                 this.SendCommand(CommandRepresentations.DisableLightCommand);
         }

void ArduinoConnection.ArduinoCommands.DisableMicroStepping ( )

Disables the micro stepping.

Definition at line 206 of file ArduinoCommands.cs.

         {
             this.SendCommand(CommandRepresentations.DisableMicroSteppingCommand);
         }

void ArduinoConnection.ArduinoCommands.EnableMicroStepping ( )

Enables the micro stepping.

Definition at line 197 of file ArduinoCommands.cs.

         {
             this.SendCommand(CommandRepresentations.EnableMicroSteppingCommand);
         }

string ArduinoConnection.ArduinoCommands.FindComPort ( )

Finds the COM port used by arduino

prerequisit: sketch must run on arduino and arduino must be powered

Returns

Definition at line 83 of file ArduinoCommands.cs.

         {
             try
             {
                 string[] ports = SerialPort.GetPortNames();
                 foreach (string port in ports)
                 {
                     string testPort = port;
                     Task<string> detectPort = Task<string>.Factory.StartNew(() =>
                     {
                         Singleton<Logger>.Instance.LogInfo($"Testing COM port:{testPort}");
                         SerialPort serialPort = new SerialPort(testPort, this.baudRate) {ReadTimeout = 2000};
                         return this.DetectArduino(serialPort) ? testPort : String.Empty;
                     });
 
                     if (detectPort.Wait(5000))
                     {
 
                         string detectedPort = detectPort.Result;
 
                         if (String.IsNullOrEmpty(detectedPort))
                             this.PortFound = false;
                         else
                         {
                             Singleton<Logger>.Instance.LogInfo($"Using Arduino on COM port:{detectedPort}");
                             this.PortString = detectedPort;
                             this.PortFound = true;
                             this.currentPort = new SerialPort(testPort, this.baudRate) {ReadTimeout = 2000};
                             return this.PortString;
                         }
                     }
                     else
                     {
                         this.PortFound = false;
                     }
                 }
             }
             catch (Exception ex)
             {
                 Singleton<Logger>.Instance.LogException(ex);
             }
             return string.Empty;
         }

Here is the caller graph for this function:

void ArduinoConnection.ArduinoCommands.RotateLaserCcw ( int steps )

Rotates the laser counter clockwise.

Parameters

steps The steps.

Definition at line 188 of file ArduinoCommands.cs.

         {
             this.SendCommand(CommandRepresentations.RotateLaserCcwCommand, steps);
         }

Here is the caller graph for this function:

void ArduinoConnection.ArduinoCommands.RotateLaserCw ( int steps )

Rotates the laser clockwise.

Parameters

steps The steps.

Definition at line 178 of file ArduinoCommands.cs.

         {
             this.SendCommand(CommandRepresentations.RotateLaserCwCommand, steps);
         }

Here is the caller graph for this function:

void ArduinoConnection.ArduinoCommands.RotateTurnTableCcw ( int steps )

Rotates the turn table counter clockwise.

Parameters

steps The steps.

Definition at line 168 of file ArduinoCommands.cs.

         {
             this.SendCommand(CommandRepresentations.RotateTurnTableCcwCommand, steps);
         }

void ArduinoConnection.ArduinoCommands.RotateTurnTableCw ( int steps )

Rotates the turn table clockwise.

Parameters

steps The steps.

Definition at line 158 of file ArduinoCommands.cs.

         {
             this.SendCommand(CommandRepresentations.RotateTurnTableCwCommand, steps);
         }

Here is the caller graph for this function:

Property Documentation

bool ArduinoConnection.ArduinoCommands.PortFound

get

Gets a value indicating whether [port found].

true if [port found]; otherwise, false.

Definition at line 25 of file ArduinoCommands.cs.

string ArduinoConnection.ArduinoCommands.PortString

get

Gets the port string.

The port string.

Definition at line 33 of file ArduinoCommands.cs.

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

C:/Entwicklung/Simple3DScan/Simple3DScan/ArduinoConnection/ArduinoCommands.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation