Index:


Finch

Class Finch


The Finch class contains methods necessary to connect to, read from, and set actuators on the Finch robot.
Author: Daragh Egan

Public:


Methods:
 Public Sub buzz ( ByVal duration As UInt16 ByVal frequency As UInt16 )
 Public Sub connect ( )
 Public Function getAccelerations ( ) As Double ( )
 Public Function getLeftLightSensor ( ) As Integer
 Public Function getLightSensors ( ) As Integer ( )
 Public Function getObstacleSensors ( ) As Boolean ( )
 Public Function getRightLightSensor ( ) As Integer
 Public Function getTemperature ( ) As Double
 Public Function getXAcceleration ( ) As Double
 Public Function getYAcceleration ( ) As Double
 Public Function getZAcceleration ( ) As Double
 Public Function isBeakDown ( ) As Boolean
 Public Function isBeakUp ( ) As Boolean
 Public Function isConnected ( ) As Boolean
 Public Function isFinchLevel ( ) As Boolean
 Public Function isFinchUpsideDown ( ) As Boolean
 Public Function isLeftLightSensor ( ByVal limit As Integer ) As Boolean
 Public Function isLeftWingDown ( ) As Boolean
 Public Function isObstacle ( ) As Boolean
 Public Function isObstacleLeftside ( ) As Boolean
 Public Function isObstacleRightSide ( ) As Boolean
 Public Function isRightLightSensor ( ByVal limit As Integer ) As Boolean
 Public Function isRightWingDown ( ) As Boolean
 Public Function isShaken ( ) As Boolean
 Public Function isTapped ( ) As Boolean
 Public Function isTemperature ( ByVal limit As Double ) As Boolean
 Public Sub New ( )
 Public Sub quit ( )
 Public Function sendData ( ByVal writeBuffer ( ) As Byte ByVal hasReply As Boolean ) As Byte ( )
 Public Sub setLED ( ByVal red As UInteger ByVal green As UInteger ByVal blue As UInteger ByVal duration As UInteger )
 Public Sub setLED ( ByVal red As UInteger ByVal green As UInteger ByVal blue As UInteger )
 Public Sub setWheelVelocities ( ByVal leftvelocity As Integer ByVal rightvelocity As Integer )
 Public Sub setWheelVelocities ( ByVal leftVelocity As Integer ByVal rightVelocity As Integer ByVal duration As UInteger )
 Public Sub sleep ( ByVal ms As UInteger )
 Public Sub startBuzz ( ByVal frequency As Int16 )
 Public Sub stopBuzz ( )
 Public Sub stopWheels ( )

Documentation:


 Public Sub buzz ( ByVal duration As UInt16 ByVal frequency As UInt16 )

Plays the buzzer for a length of time at a frequency.



moduleindexbacktop
 Public Sub connect ( )

Tries to connect to the finch. Called automatically when Finch is initialized.



moduleindexbacktop
 Public Function getAccelerations ( ) As Double ( )

Reads accelerometer values.



moduleindexbacktop
 Public Function getLeftLightSensor ( ) As Integer

Returns the value of the left light sensor.



moduleindexbacktop
 Public Function getLightSensors ( ) As Integer ( )

Gets values being read by the light sensors.



moduleindexbacktop
 Public Function getObstacleSensors ( ) As Boolean ( )

Reads obstacle sensors.



moduleindexbacktop
 Public Function getRightLightSensor ( ) As Integer

Returns the value of the right light sensor.



moduleindexbacktop
 Public Function getTemperature ( ) As Double

Reads temperature as measured by Finchs nose sensor.



moduleindexbacktop
 Public Function getXAcceleration ( ) As Double

Returns the acceleration experienced by the Finch on the X axis.



moduleindexbacktop
 Public Function getYAcceleration ( ) As Double

Returns the acceleration experienced by the Finch on the Y axis.



moduleindexbacktop
 Public Function getZAcceleration ( ) As Double

Returns the acceleration experienced bt the Finch on the Z axis.



moduleindexbacktop
 Public Function isBeakDown ( ) As Boolean

Uses the accelerometer to determine orientation.



moduleindexbacktop
 Public Function isBeakUp ( ) As Boolean

Uses the accelerometer to determine orientation.



moduleindexbacktop
 Public Function isConnected ( ) As Boolean

Check Finch connection status



moduleindexbacktop
 Public Function isFinchLevel ( ) As Boolean

Uses the accelerometer to determine orientation.



moduleindexbacktop
 Public Function isFinchUpsideDown ( ) As Boolean

Uses the accelerometer to determine orientation.



moduleindexbacktop
 Public Function isLeftLightSensor ( ByVal limit As Integer ) As Boolean

Simple way to test the left light sensors value against a limit.



moduleindexbacktop
 Public Function isLeftWingDown ( ) As Boolean

Uses the accelerometer to determine orientation.



moduleindexbacktop
 Public Function isObstacle ( ) As Boolean

Simple check to see if there is an obstacle detected.



moduleindexbacktop
 Public Function isObstacleLeftside ( ) As Boolean

Checks the left obstacle sensor.



moduleindexbacktop
 Public Function isObstacleRightSide ( ) As Boolean

Checks the right obstacle sensor.



moduleindexbacktop
 Public Function isRightLightSensor ( ByVal limit As Integer ) As Boolean

Simple way to test the right light sensors value against a limit.



moduleindexbacktop
 Public Function isRightWingDown ( ) As Boolean

Uses the accelerometer to determine orientation.



moduleindexbacktop
 Public Function isShaken ( ) As Boolean

Checks whether Finch has been shaken recently.



moduleindexbacktop
 Public Function isTapped ( ) As Boolean

Checks if the accelerometer detected a tap recently.



moduleindexbacktop
 Public Function isTemperature ( ByVal limit As Double ) As Boolean

Checks the current temperature against a value.



moduleindexbacktop
 Public Sub quit ( )

Disconnects the Finch from the application and returns it to idle mode.



moduleindexbacktop
 Public Function sendData ( ByVal writeBuffer ( ) As Byte ByVal hasReply As Boolean ) As Byte ( )

Sends an array of 9 bytes to the finch as output. Returns input from Finch only if hasReply is True.



moduleindexbacktop
 Public Sub setLED ( ByVal red As UInteger ByVal green As UInteger ByVal blue As UInteger ByVal duration As UInteger )

Sets the LED for an amount of time.



moduleindexbacktop
 Public Sub setLED ( ByVal red As UInteger ByVal green As UInteger ByVal blue As UInteger )

Sets the LED to the specified color.



moduleindexbacktop
 Public Sub setWheelVelocities ( ByVal leftvelocity As Integer ByVal rightvelocity As Integer )

Moves left and right motors. Positive values are forward and negative values are backward.



moduleindexbacktop
 Public Sub setWheelVelocities ( ByVal leftVelocity As Integer ByVal rightVelocity As Integer ByVal duration As UInteger )

Moves the left and right motors for a duration of time.



moduleindexbacktop
 Public Sub sleep ( ByVal ms As UInteger )

Pauses the current thread.



moduleindexbacktop
 Public Sub startBuzz ( ByVal frequency As Int16 )

Turn the buzzer on until stopBuzz is called.



moduleindexbacktop
 Public Sub stopBuzz ( )

Turn the buzzer off.



moduleindexbacktop
 Public Sub stopWheels ( )

Sets the wheel velocities to zero.



moduleindexbacktop