WebbotLib AVR library
WebbotLib It just does it
C++documentationCdocumentation

Data Type Summary

NameDescription
ACCEL_TYPE
(Based on int16_t).
Stores an acceleration in thousandths of the gravitational constant.
BAUD_RATE
(Based on uint32_t).
A communications baud rate (bits per second).
BLACKFIN_RESOLUTION
Can be one of the following values:
BLACKFIN_160_BY_120
BLACKFIN_320_BY_240
BLACKFIN_640_BY_480
BLACKFIN_1280_BY_1024
Blob
Holds the following information about a blob returned by a camera.
Contains the following fields:-
The left X co-ordinate of the blob.
The right X co-ordinate of the blob.
The top Y co-ordinate of the blob.
uint16_tbottom
The bottom Y co-ordinate of the blob.
int16_txCenter
The x offset from the centre of the screen to the centre of the blob.
int16_tyCenter
The y offset from the centre of the screen to the centre of the blob.
uint32_tpixels
The total number of pixels in the blob - ie width x height.
The matching colour bin number for this blob.

boolean
(Based on int8_t).
Stores TRUE or FALSE, which can also be typed as true or false.
char
Stores a single character.
char *
Stores a pointer to one or more characters. This is often used to reference a string which is terminated with a char of 0.
Color
Any kind of colour. See Color
COLOR_RGB*
A reference to a colour that is known to be RGB.
Contains the following fields:-
The red component in the range 0 to 255.
The green component in the range 0 to 255.
The blue component in the range 0 to 255.

COLOR_YUV*
A reference to a colour that is known to be YUV.
Contains the following fields:-
The y component in the range 0 to 255.
The u component in the range 0 to 255.
The v component in the range 0 to 255.

COLOR*
A reference to a COLOR in any colour space.
COMPASS_TYPE
(Based on int16_t).
Stores a compass reading in degrees.
const char *
Stores a pointer to one or more unmodifiable characters. This is often used to reference a string which is terminated with a char of 0.
CURRENT_TYPE
(Based on uint16_t).
The number of amps.
DATE_TIME*
A reference to a date and time.
Contains the following fields:-
The year.
uint8_tmonth
The month. From 1 (January) to 12 (December).
The calendar date in the month in the range 1 to 31, or less, depending on the month and year.
uint8_thours
The hour in the day based on a 24 hour clock ie 0 to 23.
uint8_tminutes
The number of minutes in the range 0 to 59.
uint8_tseconds
The number of seconds in the range 0 to 59.

DISPLAY_COLUMN
(Based on uint8_t).
The display column number. From 0 to max-1.
DISPLAY_LINE
(Based on uint8_t).
The display line number. From 0 to max-1 where 0 is the top.
DISTANCE_TYPE
(Based on uint16_t).
Stores a distance in whole centimetres. A value of DISTANCE_MAX means that there is nothing in view.
double
Stores a floating point number. Unlike most C compilers the avr-gcc compiler treats float and double as the same types.
DRIVE_SPEED
(Based on int8_t).
The speed for an actuator. This is an integer value in the range -127 to +127.
EEPROM_ADDR
(Based on uint32_t).
Holds the byte offset into an EEPROM of where you want to read or write information.
ENCODER_TYPE
(Based on int16_t).
Measures a number of encoder ticks (pulses).
File
Holds a reference to an open disk file.
FILE *
A FILEis part of the 'C' standard and is defined in <stdio.h>.
The word 'FILE' is somewhat misleading - because it does not always represent a file on a disk. Rather it represents a 'thing' that can be 'read from' and/or 'written to'.
C defines the following:
stdout - Standard Output - When you generate your code in Project Designer you can decide where this goes to.
stdin - Standard Input - This is the same device is stdout but is used to read characters from that device.
stderr - Standard Error - When you generate your code in Project Designer you can decide where this goes to. It can be the same as stdout.
In C++ these are streams and are also called cout, cin and cerr respectively.
FileIterator
A variable that is used to step through the file entries in a given directory. See FileIterator
float
Stores a floating point number. Unlike most C compilers the avr-gcc compiler treats float and double as the same types.
GraphicDisplay
A reference to a GraphicalDisplay.
GYRO_TYPE
(Based on int16_t).
An angular rotation measured in per second.
HUMIDITY_TYPE
(Based on uint16_t).
The humidity as a percentage.
int
Stores a signed integer - is the same as int16_t
int16_t
Stores whole numbers in the range -32,768 to +32,767 and requires two bytes of storage.
int32_t
Stores whole numbers in the range -2,147,483,648 to +2,147,483,647 and requires 4 bytes of storage.
int8_t
Stores whole numbers in the range -128 to +127 and requires one byte of storage.
integer
Represents any kind of integer - signed or unsigned - and of any length.
Any of the following: int8_t, int16_t, int32_t, uint8_t, uint16_t, uint32_t or int
Matrix3D
A reference to a Matrix3D
number
Any numeric data type.
Any of the following: integer or real
PERCENTAGE
(Based on uint8_t).
A percentage in the range 0 to 100.
PIXEL
(Based on int16_t).
The x or y co-ordinate of a pixel on a graphical display. The value is signed because graphical display allow values to be specified relative to the current graphics cursor position.
PRESSURE_TYPE
(Based on int32_t).
Atmospheric pressure in Pascals (Pa) .
For convesion to other units then see http://en.wikipedia.org/wiki/Pascal_(unit)
.
PS2_BUTTON
(Based on uint16_t).
A Sony PS2 controller button.
Valid values are:
PS2_BTN_SELECT
PS2_BTN_L3
PS2_BTN_R3
PS2_BTN_START
PS2_DPAD_UP
PS2_DPAD_RIGHT
PS2_DPAD_DOWN
PS2_DPAD_LEFT
PS2_BTN_L2
PS2_BTN_R2
PS2_BTN_L1
PS2_BTN_R1
PS2_BTN_TRIANGLE
PS2_BTN_CIRCLE
PS2_BTN_X
PS2_BTN_SQUARE
PS2_BUTTONS
(Based on PS2_BUTTON).
A bit map of zero or many buttons achieved by OR'ing the individual button values together or 0=None.
PS2_STICK
(Based on int).
The name of a joystick:
PS2_STICK_RIGHT_X
PS2_STICK_RIGHT_Y
PS2_STICK_LEFT_X
PS2_STICK_LEFT_Y
// virtual joysticks
PS2_STICK_DPAD_X
PS2_STICK_DPAD_Y
PS2_STICK_SHAPE_X
PS2_STICK_SHAPE_Y
real
Any type of real number.
Any of the following: float or double
SEGLED_SEGMENT
(Based on int).
Identifies each of the segments in a segmented LED display.
The segments are called:
SEGMENT_A
SEGMENT_B
SEGMENT_C
SEGMENT_D
SEGMENT_E
SEGMENT_F
SEGMENT_G
SEGMENT_H
Where the segments correspond to:
--a---
||
fb
||
--g---
||
ec
||
--d---h
Sensor
The name of a sensor - as specified in Project Designer.
size_t
Can hold a byte length - ie how many bytes.
SPI_CLOCK
The clock prescaler used by a hardware SPI bus to control the overall speed.
Possible values are:
SPI_CLOCK_DIV2
SPI_CLOCK_DIV4
SPI_CLOCK_DIV8
SPI_CLOCK_DIV16
SPI_CLOCK_DIV32
SPI_CLOCK_DIV64
SPI_CLOCK_DIV128
Larger values will cause the bus to run at a slower speed.
Stream
A reference to a Stream. This is the name of the device as specified in Project Designer.
TEMPERATURE_TYPE
(Based on int16_t).
Stores a temperature in degrees.
TICK_COUNT
(Based on uint32_t).
Stores a number in S and is used for measuring time durations.
The largest possible number is 4,294,967,295 which represents a time of just over 71 minutes.
Uart
The name of a UART - either a hardware UART or a software UART - as specified in Project Designer.
uint16_t
Stores whole numbers in the range 0 to 65,535 and requires two bytes of storage.
uint32_t
Stores whole numbers in the range 0 to 4,294,967,295 and requires 4 bytes of storage.
uint8_t
Stores whole numbers in the range 0 to 255 and requires one byte of storage.
uint8_t *
Stores the address of an 'uint8_t'.
Vector2D
A reference to a Vector2D
Vector3D
A reference to a Vector3D
void (* callback)(TonePlayer& player)
Defines a callback for the Tone Player that is called when the current tone has finished.
void (*rx_func)(unsigned char, Uart&, void*)
The address of a UART receive callback function.
void *
Stores a reference to something - ie its start address in memory.
VOLTAGE_TYPE
(Based on int16_t).
Stores a voltage.

Valid XHTML 1.0 Transitional