ArduinoConnection.ArduinoConnection Class Reference

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

Public Member Functions
	ArduinoConnection (string portString="")
	Initializes a new instance of the ArduinoConnection 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 12 of file ArduinoConnection.cs.

Constructor & Destructor Documentation

ArduinoConnection.ArduinoConnection.ArduinoConnection

(

string

portString = ""

)

Initializes a new instance of the ArduinoConnection class.

Parameters

portString

The port string.

Definition at line 34 of file ArduinoConnection.cs.

        {
            if (String.IsNullOrEmpty(portString))
                FindComPort();
            else
            {
                PortString = portString;
                currentPort = new SerialPort(PortString, Configuration.Configuration.Information.Arduino.BaudRate) { ReadTimeout = 1000 };
            }
        }

Member Function Documentation

void ArduinoConnection.ArduinoConnection.ActivateLaser

(

bool

on = true

)

Activates the laser.

Parameters

on	if set to true [on].

Definition at line 78 of file ArduinoConnection.cs.

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

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

Activates the light.

Parameters

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

Definition at line 87 of file ArduinoConnection.cs.

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

void ArduinoConnection.ArduinoConnection.DisableMicroStepping

(

)

Disables the micro stepping.

Definition at line 142 of file ArduinoConnection.cs.

        {
            SendCommand(ArduinoConfiguration.DisableMicroSteppingCommand);
        }

void ArduinoConnection.ArduinoConnection.EnableMicroStepping

(

)

Enables the micro stepping.

Definition at line 134 of file ArduinoConnection.cs.

        {
            SendCommand(ArduinoConfiguration.EnableMicroSteppingCommand);
        }

string ArduinoConnection.ArduinoConnection.FindComPort

(

)

Finds the COM port used by arduino

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

Returns

Definition at line 50 of file ArduinoConnection.cs.

        {
            try
            {
                string[] ports = SerialPort.GetPortNames();
                foreach (string port in ports)
                {
                    currentPort = new SerialPort(port, Configuration.Configuration.Information.Arduino.BaudRate);
                    if (DetectArduino())
                    {
                        
                        PortFound = true;
                        return PortString = port;
                    }
                    PortFound = false;
                }
            }
            catch (Exception ex)
            {
                Singleton<Logger>.Instance.LogException(ex);
            }
            return string.Empty;
        }

void ArduinoConnection.ArduinoConnection.RotateLaserCcw

(

int

steps

)

Rotates the laser counter clockwise.

Parameters

steps

The steps.

Definition at line 126 of file ArduinoConnection.cs.

        {
            SendCommand(ArduinoConfiguration.RotateLaserCcwCommand, steps);
        }

void ArduinoConnection.ArduinoConnection.RotateLaserCw

(

int

steps

)

Rotates the laser clockwise.

Parameters

steps

The steps.

Definition at line 117 of file ArduinoConnection.cs.

        {
            SendCommand(ArduinoConfiguration.RotateLaserCwCommand, steps);
        }

void ArduinoConnection.ArduinoConnection.RotateTurnTableCcw

(

int

steps

)

Rotates the turn table counter clockwise.

Parameters

steps

The steps.

Definition at line 108 of file ArduinoConnection.cs.

        {
            SendCommand(ArduinoConfiguration.RotateTurnTableCcwCommand, steps);
        }

void ArduinoConnection.ArduinoConnection.RotateTurnTableCw

(

int

steps

)

Rotates the turn table clockwise.

Parameters

steps

The steps.

Definition at line 99 of file ArduinoConnection.cs.

        {
           SendCommand(ArduinoConfiguration.RotateTurnTableCwCommand, steps);
        }

Property Documentation

bool ArduinoConnection.ArduinoConnection.PortFound

get

Gets a value indicating whether [port found].

true if [port found]; otherwise, false.

Definition at line 21 of file ArduinoConnection.cs.

string ArduinoConnection.ArduinoConnection.PortString

get

Gets the port string.

The port string.

Definition at line 28 of file ArduinoConnection.cs.

---

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

• C:/Entwicklung/Simple3DScan/Simple3DScan/ArduinoControl/ArduinoConnection.cs