circle_api.h File Reference

General header for the STM32-circle projects. More...

Go to the source code of this file.

Data Structures
struct	tMEMS_Info
	MEMS state description. More...
struct	tPointer_Info
	Pointer position description. More...
struct	tFontDef
struct	tFontTable
struct	tMenuItem
	Menu item description. More...
struct	tMenu
	Menu description. More...
struct	tToolbarItem
	Toolbar item description. More...
struct	tToolbar
	Toolbar description. More...
struct	tListItem
	List item description. More...
struct	tList
	List description. More...
struct	_tagVOLINFO
	Volume information structure. More...
struct	_tagDIRENT
	Directory entry structure. More...
struct	_tagDIRINFO
	Directory search structure. More...
struct	_tagFILEINFO
	File handle structure. More...
Defines
#define	RGB_MAKE(xR, xG, xB)
#define	RGB_RED   RGB_MAKE(0xFF, 0x00, 0x00)
#define	RGB_GREEN   RGB_MAKE(0x00, 0xFF, 0x00)
#define	RGB_PASTELGREEN   RGB_MAKE(0x00, 0xFF, 0x00)
#define	RGB_LIGHTBLUE   RGB_MAKE(0x00, 0x00, 0xFF)
#define	RGB_BLUE   RGB_MAKE(0x00, 0x00, 0xFF)
#define	RGB_BLACK   RGB_MAKE(0x00, 0x00, 0x00)
#define	RGB_WHITE   RGB_MAKE(0xFF, 0xFF, 0xFF)
#define	RGB_YELLOW   RGB_MAKE(0xFF, 0xFF, 0x00)
#define	RGB_MAGENTA   RGB_MAKE(0xFF, 0x00, 0xFF)
#define	RGB_TURQUOISE   RGB_MAKE(0x00, 0xFF, 0xFF)
#define	RGB_ORANGE   RGB_MAKE(0xFF, 0x80, 0x40)
#define	RGB_PINK   RGB_MAKE(0xFF, 0x3F, 0xFF)
#define	RGB_LIGHTGREY   RGB_MAKE(0xC0, 0xC0, 0xC0)
#define	RGB_DARKGREY   RGB_MAKE(0x80, 0x80, 0x80)
#define	RGB_DARKBLUE   RGB_MAKE(0x00, 0x00, 0xA0)
#define	RGB_LIGHTPURPLE   RGB_MAKE(0xFF, 0x00, 0x80)
#define	RGB_DARKPURPLE   RGB_MAKE(0x80, 0x00, 0x80)
#define	RGB_BROWN   RGB_MAKE(0x80, 0x40, 0x00)
#define	RGB_BURGUNDY   RGB_MAKE(0x80, 0x00, 0x00)
#define	RGB_FORESTGREEN   RGB_MAKE(0x80, 0x80, 0x00)
#define	RGB_GRASSGREEN   RGB_MAKE(0x40, 0x80, 0x80)
#define	BACKLIGHTMIN   0x1000
#define	DEFAULT_CCR_BACKLIGHTSTART   0x8000
#define	CHAR_WIDTH   7
#define	CHAR_HEIGHT   14
#define	MAX_FONT_NB   20
#define	INVERTED_TEXT   1
#define	NORMAL_TEXT   0
#define	ALL_SCREEN   -1
#define	REMOVE_MENU   0x01
#define	APP_MENU   0x02
#define	MENU_MAXITEM   8
#define	BKP_SYS1   1
#define	BKP_SYS2   2
#define	BKP_SYS3   3
#define	BKP_SYS4   4
#define	BKP_SYS5   5
#define	BKP_SYS6   6
#define	BKP_SYS7   11
#define	BKP_SYS8   12
#define	BKP_SYS9   13
#define	BKP_SYS10   14
#define	BKP_SYS11   15
#define	BKP_SYS12   16
#define	BKP_SYS13   17
#define	BKP_SYS14   18
#define	BKP_USER1   7
#define	BKP_USER2   8
#define	BKP_USER3   9
#define	BKP_USER4   10
#define	TOOLBAR_MAXITEMS   4
#define	LIST_MAXITEM   64
#define	MAX_PATH_LENGTH   200
#define	FS_OK   0
#define	FS_EOF   1
#define	FS_WRITEPROT   2
#define	FS_NOTFOUND   3
#define	FS_PATHLEN   4
#define	FS_ALLOCNEW   5
#define	FS_ERRMISC   0xffffffff
#define	FS_READ   1
#define	FS_WRITE   2
#define	FS_CREATEDIR   (2+4)
#define	FS_ATTR_READ_ONLY   0x01
#define	FS_ATTR_HIDDEN   0x02
#define	FS_ATTR_SYSTEM   0x04
#define	FS_ATTR_VOLUME_ID   0x08
#define	FS_ATTR_DIRECTORY   0x10
#define	FS_ATTR_ARCHIVE   0x20
#define	FS_ATTR_LONG_NAME   (FS_ATTR_READ_ONLY | FS_ATTR_HIDDEN | FS_ATTR_SYSTEM | FS_ATTR_VOLUME_ID)
Typedefs
typedef s8	sound_type
typedef enum STORAGE_device	eSTORAGE_device
typedef struct _tagVOLINFO	VOLINFO
typedef struct _tagVOLINFO *	PVOLINFO
typedef struct _tagDIRENT	DIRENT
typedef struct _tagDIRENT *	PDIRENT
typedef struct _tagDIRINFO	DIRINFO
typedef struct _tagDIRINFO *	PDIRINFO
typedef struct _tagFILEINFO	FILEINFO
typedef struct _tagFILEINFO *	PFILEINFO
typedef void(*	tAppPtrMgr )(coord_t sposX, coord_t sposY)
Enumerations
enum	eSpeed {   SPEED_VERY_LOW = 1, SPEED_LOW = 2, SPEED_MEDIUM = 3, SPEED_HIGH = 4,   SPEED_VERY_HIGH = 5 }
	Clock speeds. More...
enum	eSchHandler {   UNUSED0_SCHHDL_ID = 0, LED_SCHHDL_ID = 1, BUTTON_SCHHDL_ID = 2, BUZZER_SCHHDL_ID = 3,   MENU_SCHHDL_ID = 4, POINTER_SCHHDL_ID = 5, LCD_SCHHDL_ID = 6, DRAW_SCHHDL_ID = 7,   RTC_SCHHDL_ID = 8, UNUSED1_SCHHDL_ID = 9, UNUSED2_SCHHDL_ID = 10, UNUSED3_SCHHDL_ID = 11,   UNUSED4_SCHHDL_ID = 12, UNUSED5_SCHHDL_ID = 13, UNUSED6_SCHHDL_ID = 14, UNUSED7_SCHHDL_ID = 15,   UNUSED8_SCHHDL_ID = 16 }
enum	Rotate_H12_V_Match_TypeDef {   V12 = 0, V3 = 1, V6 = 2, V9 = 3,   V12BMP = 4, V3BMP = 5, V6BMP = 6, V9BMP = 7 }
	The 4 possible rotations. More...
enum	POINTER_mode {   POINTER_UNDEF = -1, POINTER_OFF = 0, POINTER_ON = 1, POINTER_MENU = 2,   POINTER_APPLICATION = 3, POINTER_RESTORE_LESS = 4 }
	Available pointer modes. More...
enum	POINTER_state { POINTER_S_UNDEF = -1, POINTER_S_DISABLED = 0, POINTER_S_ENABLED = 1 }
	The different pointer modes. More...
enum	BUTTON_mode { BUTTON_DISABLED = -1, BUTTON_ONOFF = 0, BUTTON_ONOFF_FORMAIN = 1, BUTTON_WITHCLICK = 2 }
	Available button modes. More...
enum	BUTTON_state {   BUTTON_UNDEF = -1, BUTTON_RELEASED = 0, BUTTON_PUSHED = 1, BUTTON_PUSHED_FORMAIN = 2,   BUTTON_CLICK = 3, BUTTON_DBLCLICK = 4 }
	CircleOS button states. More...
enum	JOYSTICK_state {   JOYSTICK_UNDEF = -1, JOYSTICK_RELEASED = 0, JOYSTICK_LEFT = 1, JOYSTICK_UP = 2,   JOYSTICK_RIGHT = 3, JOYSTICK_DOWN = 4, JOYSTICK_RIGHT_UP = 11, JOYSTICK_LEFT_UP = 5,   JOYSTICK_RIGHT_DOWN = 13, JOYSTICK_LEFT_DOWN = 7 }
	CircleOS joystick states. More...
enum	ENUM_FontID {   FONT_PRIMER = 0, FONT_PRIMERX2 = 1, FONT_MEDIUM = 2, FONT_MEDIUMX2 = 3,   FONT_NUMBERS = 4 }
enum	Align { LEFT = 0, CENTER = 1, RIGHT = 2 }
enum	BUZZER_mode {   BUZZER_UNDEF = -1, BUZZER_OFF = 0, BUZZER_ON = 1, BUZZER_SHORTBEEP = 2,   BUZZER_LONGBEEP = 3, BUZZER_PLAYMUSIC = 4 }
	CircleOS buzzer modes. More...
enum	MENU_code {   MENU_LEAVE = 0, MENU_CONTINUE = 1, MENU_REFRESH = 2, MENU_CHANGE = 3,   MENU_CONTINUE_COMMAND = 4, MENU_LEAVE_AS_IT = 5, MENU_RESTORE_COMMAND = 6 }
	Application return values. More...
enum	LED_mode {   LED_UNDEF = -1, LED_OFF = 0, LED_ON = 1, LED_BLINKING_LF = 2,   LED_BLINKING_HF = 3 }
	LED modes. More...
enum	LED_id { LED_GREEN = 0, LED_RED = 1 }
	Available LEDs. More...
enum	TOUCHSCR_Mode_enum { TS_NORMAL, TS_DRAWING, TS_CALIBRATION }
enum	ON_OFF_enum { OFF, ON }
enum	AUDIO_DeviceMode_enum { AUDIO_MODE, VOICE_MODE, AUDIO_CIRCULAR_MODE, VOICE_CIRCULAR_MODE }
enum	AUDIO_Playback_status_enum { NO_SOUND, IS_PLAYING }
enum	AUDIO_Recording_status_enum { NO_RECORD, IS_RECORDING }
enum	AUDIO_Length_enum { LG_8_BITS, LG_16_BITS }
enum	AUDIO_Frequency_enum {   FRQ_48KHZ, FRQ_44KHZ, FRQ_22KHZ, FRQ_16KHZ,   FRQ_8KHZ }
enum	AUDIO_Format_enum { MONO, STEREO }
enum	AUDIO_PlaybackBuffer_Status { FULL = 0, LOW_EMPTY = 1, HIGH_EMPTY = 2 }
enum	AUDIO_RecordBuffer_Status { EMPTY = 0, LOW_FULL = 1, HIGH_FULL = 2 }
enum	STORAGE_device { MMCSD_SDIO, INTERNAL_FLASH }
Variables
enum eSpeed	CurrentSpeed

---

Detailed Description

Author:

FL

Date:

07/2007

Version:

1.2

Date:

10/2007

Version:

1.5 types of OutX_F64 and OutX_F256 changed to u32 (same for Y and Z)

Date:

10/2007

Version:

1.6 Add the IRQ handler replacement

1.7 With vectorized scheduler handler

3.0 Add Primer2 management and ST lib v2.0.3

Date:

10/2008

Version:

3.8 CMSIS compliance and ST lib v3.1.0

Date:

08/2009

Version:

4.0 OPEN4 support

Date:

05/2010

Version:

4.1 Fonts, transparency and application full screen support

Date:

08/2010

Version:

4.2 Add STM32L platform

Date:

04/2011

It contains the list of the utilities functions organized by sections (MEMS, LCD, POINTER, ...)

Definition in file circle_api.h.

---

Define Documentation

#define ALL_SCREEN   -1

Definition at line 593 of file circle_api.h.

#define APP_MENU   0x02

Menu flag: item is an application.

Definition at line 701 of file circle_api.h.

#define BACKLIGHTMIN   0x1000

Minimal PWM rate.

Definition at line 484 of file circle_api.h.

#define BKP_SYS1   1

Backup register reserved for OS

Definition at line 843 of file circle_api.h.

#define BKP_SYS10   14

Backup register reserved for OS

Definition at line 852 of file circle_api.h.

#define BKP_SYS11   15

Backup register reserved for OS

Definition at line 853 of file circle_api.h.

#define BKP_SYS12   16

Backup register reserved for OS

Definition at line 854 of file circle_api.h.

#define BKP_SYS13   17

Backup register reserved for OS

Definition at line 855 of file circle_api.h.

#define BKP_SYS14   18

Backup register reserved for OS

Definition at line 856 of file circle_api.h.

#define BKP_SYS2   2

Backup register reserved for OS

Definition at line 844 of file circle_api.h.

#define BKP_SYS3   3

Backup register reserved for OS

Definition at line 845 of file circle_api.h.

#define BKP_SYS4   4

Backup register reserved for OS

Definition at line 846 of file circle_api.h.

#define BKP_SYS5   5

Backup register reserved for OS

Definition at line 847 of file circle_api.h.

#define BKP_SYS6   6

Backup register reserved for OS

Definition at line 848 of file circle_api.h.

#define BKP_SYS7   11

Backup register reserved for OS

Definition at line 849 of file circle_api.h.

#define BKP_SYS8   12

Backup register reserved for OS

Definition at line 850 of file circle_api.h.

#define BKP_SYS9   13

Backup register reserved for OS

Definition at line 851 of file circle_api.h.

#define BKP_USER1   7

Backup available for users application

Definition at line 858 of file circle_api.h.

#define BKP_USER2   8

Backup available for users application

Definition at line 859 of file circle_api.h.

#define BKP_USER3   9

Backup available for users application

Definition at line 860 of file circle_api.h.

#define BKP_USER4   10

Backup available for users application

Definition at line 861 of file circle_api.h.

#define CHAR_HEIGHT   14

Height of a character.

Definition at line 489 of file circle_api.h.

#define CHAR_WIDTH   7

Width of a character.

Definition at line 488 of file circle_api.h.

#define DEFAULT_CCR_BACKLIGHTSTART   0x8000

Default PWM rate.

Definition at line 485 of file circle_api.h.

#define FS_ALLOCNEW   5

Definition at line 1074 of file circle_api.h.

#define FS_ATTR_ARCHIVE   0x20

Definition at line 1090 of file circle_api.h.

#define FS_ATTR_DIRECTORY   0x10

Definition at line 1089 of file circle_api.h.

#define FS_ATTR_HIDDEN   0x02

Definition at line 1086 of file circle_api.h.

#define FS_ATTR_LONG_NAME   (FS_ATTR_READ_ONLY | FS_ATTR_HIDDEN | FS_ATTR_SYSTEM | FS_ATTR_VOLUME_ID)

Definition at line 1091 of file circle_api.h.

#define FS_ATTR_READ_ONLY   0x01

Definition at line 1085 of file circle_api.h.

#define FS_ATTR_SYSTEM   0x04

Definition at line 1087 of file circle_api.h.

#define FS_ATTR_VOLUME_ID   0x08

Definition at line 1088 of file circle_api.h.

#define FS_CREATEDIR   (2+4)

Definition at line 1081 of file circle_api.h.

#define FS_EOF   1

Definition at line 1070 of file circle_api.h.

#define FS_ERRMISC   0xffffffff

Definition at line 1075 of file circle_api.h.

#define FS_NOTFOUND   3

Definition at line 1072 of file circle_api.h.

#define FS_OK   0

Definition at line 1069 of file circle_api.h.

#define FS_PATHLEN   4

Definition at line 1073 of file circle_api.h.

#define FS_READ   1

Definition at line 1079 of file circle_api.h.

#define FS_WRITE   2

Definition at line 1080 of file circle_api.h.

#define FS_WRITEPROT   2

Definition at line 1071 of file circle_api.h.

#define INVERTED_TEXT   1

Text is displayed inverted.

Definition at line 591 of file circle_api.h.

#define LIST_MAXITEM   64

Definition at line 921 of file circle_api.h.

#define MAX_FONT_NB   20

Definition at line 492 of file circle_api.h.

#define MAX_PATH_LENGTH   200

Definition at line 1065 of file circle_api.h.

#define MENU_MAXITEM   8

Maximum number of item in a menu.

Definition at line 702 of file circle_api.h.

#define NORMAL_TEXT   0

Text is displayed normaly.

Definition at line 592 of file circle_api.h.

#define REMOVE_MENU   0x01

Menu flag: remove menu when item selected.

Definition at line 700 of file circle_api.h.

#define RGB_BLACK   RGB_MAKE(0x00, 0x00, 0x00)

Definition at line 466 of file circle_api.h.

#define RGB_BLUE   RGB_MAKE(0x00, 0x00, 0xFF)

Definition at line 465 of file circle_api.h.

#define RGB_BROWN   RGB_MAKE(0x80, 0x40, 0x00)

Definition at line 478 of file circle_api.h.

#define RGB_BURGUNDY   RGB_MAKE(0x80, 0x00, 0x00)

Definition at line 479 of file circle_api.h.

#define RGB_DARKBLUE   RGB_MAKE(0x00, 0x00, 0xA0)

Definition at line 475 of file circle_api.h.

#define RGB_DARKGREY   RGB_MAKE(0x80, 0x80, 0x80)

Definition at line 474 of file circle_api.h.

#define RGB_DARKPURPLE   RGB_MAKE(0x80, 0x00, 0x80)

Definition at line 477 of file circle_api.h.

#define RGB_FORESTGREEN   RGB_MAKE(0x80, 0x80, 0x00)

Definition at line 480 of file circle_api.h.

#define RGB_GRASSGREEN   RGB_MAKE(0x40, 0x80, 0x80)

Definition at line 481 of file circle_api.h.

#define RGB_GREEN   RGB_MAKE(0x00, 0xFF, 0x00)

Definition at line 462 of file circle_api.h.

#define RGB_LIGHTBLUE   RGB_MAKE(0x00, 0x00, 0xFF)

Definition at line 464 of file circle_api.h.

#define RGB_LIGHTGREY   RGB_MAKE(0xC0, 0xC0, 0xC0)

Definition at line 473 of file circle_api.h.

#define RGB_LIGHTPURPLE   RGB_MAKE(0xFF, 0x00, 0x80)

Definition at line 476 of file circle_api.h.

#define RGB_MAGENTA   RGB_MAKE(0xFF, 0x00, 0xFF)

Definition at line 469 of file circle_api.h.

#define RGB_MAKE	(	xR,
		xG,
		xB		)

Value:

( ( (((xG)>>2)&0x07)<<13 ) + ( (xG)>>5 )  +      \
                                ( ((xB)>>3) << 8 )          +      \
                                ( ((xR)>>3) << 3 ) )

Macro to make a LCD compatible color format from RGB.

Definition at line 454 of file circle_api.h.

#define RGB_ORANGE   RGB_MAKE(0xFF, 0x80, 0x40)

Definition at line 471 of file circle_api.h.

#define RGB_PASTELGREEN   RGB_MAKE(0x00, 0xFF, 0x00)

Definition at line 463 of file circle_api.h.

#define RGB_PINK   RGB_MAKE(0xFF, 0x3F, 0xFF)

Definition at line 472 of file circle_api.h.

#define RGB_RED   RGB_MAKE(0xFF, 0x00, 0x00)

Definition at line 461 of file circle_api.h.

#define RGB_TURQUOISE   RGB_MAKE(0x00, 0xFF, 0xFF)

Definition at line 470 of file circle_api.h.

#define RGB_WHITE   RGB_MAKE(0xFF, 0xFF, 0xFF)

Definition at line 467 of file circle_api.h.

#define RGB_YELLOW   RGB_MAKE(0xFF, 0xFF, 0x00)

Definition at line 468 of file circle_api.h.

#define TOOLBAR_MAXITEMS   4

Definition at line 880 of file circle_api.h.

---

Typedef Documentation

typedef struct _tagDIRENT DIRENT

typedef struct _tagDIRINFO DIRINFO

typedef enum STORAGE_device eSTORAGE_device

typedef struct _tagFILEINFO FILEINFO

typedef struct _tagDIRENT * PDIRENT

typedef struct _tagDIRINFO * PDIRINFO

typedef struct _tagFILEINFO * PFILEINFO

typedef struct _tagVOLINFO * PVOLINFO

typedef s8 sound_type

Definition at line 992 of file circle_api.h.

typedef void( * tAppPtrMgr)(coord_t sposX, coord_t sposY)

Definition at line 1253 of file circle_api.h.

typedef struct _tagVOLINFO VOLINFO

---

Enumeration Type Documentation

enum Align

Enumerator:

LEFT
CENTER
RIGHT

Definition at line 590 of file circle_api.h.

enum AUDIO_DeviceMode_enum

Enumerator:

AUDIO_MODE
VOICE_MODE
AUDIO_CIRCULAR_MODE
VOICE_CIRCULAR_MODE

Definition at line 984 of file circle_api.h.

enum AUDIO_Format_enum

Enumerator:

MONO
STEREO

Definition at line 989 of file circle_api.h.

enum AUDIO_Frequency_enum

Enumerator:

FRQ_48KHZ
FRQ_44KHZ
FRQ_22KHZ
FRQ_16KHZ
FRQ_8KHZ

Definition at line 988 of file circle_api.h.

enum AUDIO_Length_enum

Enumerator:

LG_8_BITS
LG_16_BITS

Definition at line 987 of file circle_api.h.

enum AUDIO_Playback_status_enum

Enumerator:

NO_SOUND
IS_PLAYING

Definition at line 985 of file circle_api.h.

enum AUDIO_PlaybackBuffer_Status

Enumerator:

FULL
LOW_EMPTY
HIGH_EMPTY

Definition at line 990 of file circle_api.h.

enum AUDIO_RecordBuffer_Status

Enumerator:

EMPTY
LOW_FULL
HIGH_FULL

Definition at line 991 of file circle_api.h.

enum AUDIO_Recording_status_enum

Enumerator:

NO_RECORD
IS_RECORDING

Definition at line 986 of file circle_api.h.

enum BUTTON_mode

List of all the available button mode in the CircleOS.

Enumerator:

BUTTON_DISABLED	No action on the button is detected.
BUTTON_ONOFF	Detect ON/OFF pression type.
BUTTON_ONOFF_FORMAIN	Special mode for main screen.
BUTTON_WITHCLICK	Currently unused.

Definition at line 367 of file circle_api.h.

enum BUTTON_state

Description of the button states provided by CircleOS.

Enumerator:

BUTTON_UNDEF	Undefined state.
BUTTON_RELEASED	Button is released.
BUTTON_PUSHED	Button was just pushed.
BUTTON_PUSHED_FORMAIN	Same as BUTTON_PUSHED when button mode is BUTTON_ONOFF_FORMAIN.
BUTTON_CLICK	Currently unused.
BUTTON_DBLCLICK	Currently unused.

Definition at line 381 of file circle_api.h.

enum BUZZER_mode

Without the undefined mode, the CircleOS provides 5 modes for its buzzer.

Enumerator:

BUZZER_UNDEF	undefined mode for buzzer
BUZZER_OFF	The buzzer is put off.
BUZZER_ON	The buzzer is put on.
BUZZER_SHORTBEEP	Make buzzer to bip for a short time
BUZZER_LONGBEEP	Make buzzer to bip for a long time
BUZZER_PLAYMUSIC	Make buzzer to play a music

Definition at line 668 of file circle_api.h.

enum ENUM_FontID

Enumerator:

FONT_PRIMER
FONT_PRIMERX2
FONT_MEDIUM
FONT_MEDIUMX2
FONT_NUMBERS

Definition at line 494 of file circle_api.h.

enum eSchHandler

Enumerator:

UNUSED0_SCHHDL_ID
LED_SCHHDL_ID
BUTTON_SCHHDL_ID
BUZZER_SCHHDL_ID
MENU_SCHHDL_ID
POINTER_SCHHDL_ID
LCD_SCHHDL_ID
DRAW_SCHHDL_ID
RTC_SCHHDL_ID
UNUSED1_SCHHDL_ID
UNUSED2_SCHHDL_ID
UNUSED3_SCHHDL_ID
UNUSED4_SCHHDL_ID
UNUSED5_SCHHDL_ID
UNUSED6_SCHHDL_ID
UNUSED7_SCHHDL_ID
UNUSED8_SCHHDL_ID

Definition at line 66 of file circle_api.h.

enum eSpeed

Available clock speeds.

Enumerator:

SPEED_VERY_LOW
SPEED_LOW
SPEED_MEDIUM
SPEED_HIGH
SPEED_VERY_HIGH

Definition at line 57 of file circle_api.h.

enum JOYSTICK_state

Description of the joystick states provided by CircleOS.

Enumerator:

JOYSTICK_UNDEF	Undefined state.
JOYSTICK_RELEASED	Joystick is released.
JOYSTICK_LEFT	Joystick was just pushed left.
JOYSTICK_UP	Joystick was just pushed up.
JOYSTICK_RIGHT	Joystick was just pushed right.
JOYSTICK_DOWN	Joystick was just pushed down.
JOYSTICK_RIGHT_UP
JOYSTICK_LEFT_UP
JOYSTICK_RIGHT_DOWN
JOYSTICK_LEFT_DOWN

Definition at line 420 of file circle_api.h.

enum LED_id

List of all the available LEDs.

Enumerator:

LED_GREEN	Green led id.
LED_RED	Red led id.

Definition at line 820 of file circle_api.h.

enum LED_mode

LEDs may be on, off or blinking slowly or fastly!

Enumerator:

LED_UNDEF	Undefined led mode.
LED_OFF	Put off the led.
LED_ON	Put on the led.
LED_BLINKING_LF	Slow blinking led mode.
LED_BLINKING_HF	Fast blinking led mode.

Definition at line 805 of file circle_api.h.

enum MENU_code

List of all the codes available for CircleOS application return values.

Enumerator:

MENU_LEAVE	Leave application.
MENU_CONTINUE	Continue application.
MENU_REFRESH	Refresh current menu.
MENU_CHANGE	Change current menu.
MENU_CONTINUE_COMMAND	Sent by Ini functions.
MENU_LEAVE_AS_IT	Abort current menu or command.
MENU_RESTORE_COMMAND	Restore the previous command.

Definition at line 742 of file circle_api.h.

enum ON_OFF_enum

Enumerator:

OFF
ON

Definition at line 983 of file circle_api.h.

enum POINTER_mode

Description of all the available pointer modes in CircleOS.

Enumerator:

POINTER_UNDEF	Pointer's mode is unknown!
POINTER_OFF	Pointer isn't managed and displayed.
POINTER_ON	Pointer mode used in main screen.
POINTER_MENU	Pointer management is used to select item menu (but pointer isn't displayed).
POINTER_APPLICATION	The managment of pointer depend of extern application.
POINTER_RESTORE_LESS	The background isn't restored (to go faster).

Definition at line 267 of file circle_api.h.

enum POINTER_state

Despite beeing in a undefined state, the pointer can be disabled or enable.

Enumerator:

POINTER_S_UNDEF	Pointer state is unknown!
POINTER_S_DISABLED	Pointer is disabled.
POINTER_S_ENABLED	Pointer is enabled.

Definition at line 283 of file circle_api.h.

enum Rotate_H12_V_Match_TypeDef

The 4 possible MEM rotations.

Enumerator:

V12
V3
V6
V9
V12BMP
V3BMP
V6BMP
V9BMP

Definition at line 200 of file circle_api.h.

enum STORAGE_device

Enumerator:

MMCSD_SDIO
INTERNAL_FLASH

Definition at line 1095 of file circle_api.h.

enum TOUCHSCR_Mode_enum

Enumerator:

TS_NORMAL
TS_DRAWING
TS_CALIBRATION

Definition at line 924 of file circle_api.h.

---

Variable Documentation

enum eSpeed CurrentSpeed