Data Structures
struct	GSM_CalendarSettings

struct	GSM_CalendarStatus

struct	GSM_SubCalendarEntry

struct	GSM_CalendarEntry

struct	GSM_Alarm

Enumerations
enum	GSM_CalendarNoteType { GSM_CAL_REMINDER = 1, GSM_CAL_CALL, GSM_CAL_MEETING, GSM_CAL_BIRTHDAY, GSM_CAL_MEMO, GSM_CAL_TRAVEL, GSM_CAL_VACATION, GSM_CAL_T_ATHL, GSM_CAL_T_BALL, GSM_CAL_T_CYCL, GSM_CAL_T_BUDO, GSM_CAL_T_DANC, GSM_CAL_T_EXTR, GSM_CAL_T_FOOT, GSM_CAL_T_GOLF, GSM_CAL_T_GYM, GSM_CAL_T_HORS, GSM_CAL_T_HOCK, GSM_CAL_T_RACE, GSM_CAL_T_RUGB, GSM_CAL_T_SAIL, GSM_CAL_T_STRE, GSM_CAL_T_SWIM, GSM_CAL_T_TENN, GSM_CAL_T_TRAV, GSM_CAL_T_WINT, GSM_CAL_ALARM, GSM_CAL_DAILY_ALARM, GSM_CAL_SHOPPING }

enum	GSM_CalendarType { CAL_START_DATETIME = 1, CAL_END_DATETIME, CAL_TONE_ALARM_DATETIME, CAL_SILENT_ALARM_DATETIME, CAL_TEXT, CAL_DESCRIPTION, CAL_LOCATION, CAL_PHONE, CAL_PRIVATE, CAL_CONTACTID, CAL_REPEAT_DAYOFWEEK, CAL_REPEAT_DAY, CAL_REPEAT_DAYOFYEAR, CAL_REPEAT_WEEKOFMONTH, CAL_REPEAT_MONTH, CAL_REPEAT_FREQUENCY, CAL_REPEAT_STARTDATE, CAL_REPEAT_STOPDATE, CAL_REPEAT_COUNT, CAL_LUID, CAL_LAST_MODIFIED }

enum	GSM_VCalendarVersion { Nokia_VCalendar = 1, Siemens_VCalendar, SonyEricsson_VCalendar, Mozilla_iCalendar }

Functions
void	GSM_CalendarFindDefaultTextTimeAlarmPhone (GSM_CalendarEntry entry, int Text, int Time, int Alarm, int Phone, int EndTime, int *Location)

GSM_Error	GSM_EncodeVCALENDAR (char Buffer, const size_t buff_len, size_t Length, GSM_CalendarEntry *note, const gboolean header, const GSM_VCalendarVersion Version)

GSM_Error	GSM_DecodeVCALENDAR_VTODO (GSM_Debug_Info di, char Buffer, size_t Pos, GSM_CalendarEntry Calendar, GSM_ToDoEntry *ToDo, GSM_VCalendarVersion CalVer, GSM_VToDoVersion ToDoVer)

gboolean	GSM_IsCalendarNoteFromThePast (GSM_CalendarEntry *note)

GSM_Error	GSM_GetAlarm (GSM_StateMachine s, GSM_Alarm Alarm)

GSM_Error	GSM_SetAlarm (GSM_StateMachine s, GSM_Alarm Alarm)

GSM_Error	GSM_GetCalendarStatus (GSM_StateMachine s, GSM_CalendarStatus Status)

GSM_Error	GSM_GetCalendar (GSM_StateMachine s, GSM_CalendarEntry Note)

GSM_Error	GSM_GetNextCalendar (GSM_StateMachine s, GSM_CalendarEntry Note, gboolean start)

GSM_Error	GSM_SetCalendar (GSM_StateMachine s, GSM_CalendarEntry Note)

GSM_Error	GSM_AddCalendar (GSM_StateMachine s, GSM_CalendarEntry Note)

GSM_Error	GSM_DeleteCalendar (GSM_StateMachine s, GSM_CalendarEntry Note)

GSM_Error	GSM_DeleteAllCalendar (GSM_StateMachine *s)

GSM_Error	GSM_GetCalendarSettings (GSM_StateMachine s, GSM_CalendarSettings settings)

GSM_Error	GSM_SetCalendarSettings (GSM_StateMachine s, GSM_CalendarSettings settings)

Detailed Description

Calendar events manipulations.

Enumeration Type Documentation

§ GSM_CalendarNoteType

enum GSM_CalendarNoteType

Enum defines types of calendar notes

Enumerator
GSM_CAL_REMINDER	Reminder or Date
GSM_CAL_CALL	Call
GSM_CAL_MEETING	Meeting
GSM_CAL_BIRTHDAY	Birthday or Anniversary or Special Occasion
GSM_CAL_MEMO	Memo or Miscellaneous
GSM_CAL_TRAVEL	Travel
GSM_CAL_VACATION	Vacation
GSM_CAL_T_ATHL	Training - Athletism
GSM_CAL_T_BALL	Training - Ball Games
GSM_CAL_T_CYCL	Training - Cycling
GSM_CAL_T_BUDO	Training - Budo
GSM_CAL_T_DANC	Training - Dance
GSM_CAL_T_EXTR	Training - Extreme Sports
GSM_CAL_T_FOOT	Training - Football
GSM_CAL_T_GOLF	Training - Golf
GSM_CAL_T_GYM	Training - Gym
GSM_CAL_T_HORS	Training - Horse Race
GSM_CAL_T_HOCK	Training - Hockey
GSM_CAL_T_RACE	Training - Races
GSM_CAL_T_RUGB	Training - Rugby
GSM_CAL_T_SAIL	Training - Sailing
GSM_CAL_T_STRE	Training - Street Games
GSM_CAL_T_SWIM	Training - Swimming
GSM_CAL_T_TENN	Training - Tennis
GSM_CAL_T_TRAV	Training - Travels
GSM_CAL_T_WINT	Training - Winter Games
GSM_CAL_ALARM	Alarm
GSM_CAL_DAILY_ALARM	Alarm repeating each day.
GSM_CAL_SHOPPING	Shopping

Definition at line 86 of file gammu-calendar.h.

              {
         GSM_CAL_REMINDER = 1,
         GSM_CAL_CALL,
         GSM_CAL_MEETING,
         GSM_CAL_BIRTHDAY,
         GSM_CAL_MEMO,
         GSM_CAL_TRAVEL,
         GSM_CAL_VACATION,
         GSM_CAL_T_ATHL,
         GSM_CAL_T_BALL,
         GSM_CAL_T_CYCL,
         GSM_CAL_T_BUDO,
         GSM_CAL_T_DANC,
         GSM_CAL_T_EXTR,
         GSM_CAL_T_FOOT,
         GSM_CAL_T_GOLF,
         GSM_CAL_T_GYM,
         GSM_CAL_T_HORS,
         GSM_CAL_T_HOCK,
         GSM_CAL_T_RACE,
         GSM_CAL_T_RUGB,
         GSM_CAL_T_SAIL,
         GSM_CAL_T_STRE,
         GSM_CAL_T_SWIM,
         GSM_CAL_T_TENN,
         GSM_CAL_T_TRAV,
         GSM_CAL_T_WINT,
         GSM_CAL_ALARM,
         GSM_CAL_DAILY_ALARM,
         GSM_CAL_SHOPPING,
 } GSM_CalendarNoteType;

§ GSM_CalendarType

enum GSM_CalendarType

One value of calendar event.

Enumerator
CAL_START_DATETIME	Date and time of event start.
CAL_END_DATETIME	Date and time of event end.
CAL_TONE_ALARM_DATETIME	Alarm date and time.
CAL_SILENT_ALARM_DATETIME	Date and time of silent alarm.
CAL_TEXT	Text.
CAL_DESCRIPTION	Detailed description.
CAL_LOCATION	Location.
CAL_PHONE	Phone number.
CAL_PRIVATE	Whether this entry is private.
CAL_CONTACTID	Related contact id.
CAL_REPEAT_DAYOFWEEK	Repeat each x'th day of week.
CAL_REPEAT_DAY	Repeat each x'th day of month.
CAL_REPEAT_DAYOFYEAR	Repeat each x'th day of year.
CAL_REPEAT_WEEKOFMONTH	Repeat x'th week of month.
CAL_REPEAT_MONTH	Repeat x'th month.
CAL_REPEAT_FREQUENCY	Repeating frequency.
CAL_REPEAT_STARTDATE	Repeating start.
CAL_REPEAT_STOPDATE	Repeating end.
CAL_REPEAT_COUNT	Number of repetitions.
CAL_LUID	IrMC LUID which can be used for synchronisation.
CAL_LAST_MODIFIED	Date and time of last modification.

Definition at line 210 of file gammu-calendar.h.

              {
         CAL_START_DATETIME = 1,
         CAL_END_DATETIME,
         CAL_TONE_ALARM_DATETIME,
         CAL_SILENT_ALARM_DATETIME,
         CAL_TEXT,
         CAL_DESCRIPTION,
         CAL_LOCATION,
         CAL_PHONE,
         CAL_PRIVATE,
         CAL_CONTACTID,          /* 10 */
         CAL_REPEAT_DAYOFWEEK,
         CAL_REPEAT_DAY,
         CAL_REPEAT_DAYOFYEAR,
         CAL_REPEAT_WEEKOFMONTH,
         CAL_REPEAT_MONTH,
         CAL_REPEAT_FREQUENCY,
         CAL_REPEAT_STARTDATE,
         CAL_REPEAT_STOPDATE,
         CAL_REPEAT_COUNT,
         CAL_LUID,               /* 20 */
         CAL_LAST_MODIFIED,
 } GSM_CalendarType;

§ GSM_VCalendarVersion

enum GSM_VCalendarVersion

Format of vCalendar export.

Enumerator
Nokia_VCalendar	vCalendar specially hacked for Nokia .
Siemens_VCalendar	vCalendar specially hacked for Siemens.
SonyEricsson_VCalendar	Standard vCalendar (which works for Sony-Ericsson phones)
Mozilla_iCalendar	iCalendar as compatible with Mozilla.

Definition at line 558 of file gammu-calendar.h.

              {
         Nokia_VCalendar = 1,
         Siemens_VCalendar,
         SonyEricsson_VCalendar,
         Mozilla_iCalendar,
 } GSM_VCalendarVersion;

Function Documentation

§ GSM_AddCalendar()

GSM_Error GSM_AddCalendar	(	GSM_StateMachine *	s,
		GSM_CalendarEntry *	Note
	)

Adds calendar entry.

Parameters

s	State machine pointer.
Note	Note to add.

Returns: Error code

§ GSM_CalendarFindDefaultTextTimeAlarmPhone()

void GSM_CalendarFindDefaultTextTimeAlarmPhone	(	GSM_CalendarEntry *	entry,
		int *	Text,
		int *	Time,
		int *	Alarm,
		int *	Phone,
		int *	EndTime,
		int *	Location
	)

Finds inxedes of default entries.

§ GSM_DecodeVCALENDAR_VTODO()

GSM_Error GSM_DecodeVCALENDAR_VTODO	(	GSM_Debug_Info *	di,
		char *	Buffer,
		size_t *	Pos,
		GSM_CalendarEntry *	Calendar,
		GSM_ToDoEntry *	ToDo,
		GSM_VCalendarVersion	CalVer,
		GSM_VToDoVersion	ToDoVer
	)

Decodes vCalendar and vTodo buffer.

Parameters

di	Pointer to debugging description.
Buffer	Buffer to decode.
Pos	Current position in buffer (will be updated).
Calendar	Storage for calendar entry.
ToDo	Storage for todo entry.
CalVer	Format of vCalendar.
ToDoVer	Format of vTodo.

Returns: Error code

§ GSM_DeleteAllCalendar()

GSM_Error GSM_DeleteAllCalendar ( GSM_StateMachine * s )

Deletes all calendar entries.

Parameters

s	State machine pointer.

Returns: Error code

§ GSM_DeleteCalendar()

GSM_Error GSM_DeleteCalendar	(	GSM_StateMachine *	s,
		GSM_CalendarEntry *	Note
	)

Deletes calendar entry.

Parameters

s	State machine pointer.
Note	Note to delete, must contain position.

Returns: Error code

§ GSM_EncodeVCALENDAR()

GSM_Error GSM_EncodeVCALENDAR	(	char *	Buffer,
		const size_t	buff_len,
		size_t *	Length,
		GSM_CalendarEntry *	note,
		const gboolean	header,
		const GSM_VCalendarVersion	Version
	)

Encodes vCalendar to buffer.

Parameters

	Buffer	Storage for data.
[in]	buff_len	Size of output buffer.
	Length	Pointer to current position in data (will be incremented).
	note	Note to encode.
	header	Whether to include vCalendar header.
	Version	Format of vCalendar to create.

Returns: Error code.

§ GSM_GetAlarm()

GSM_Error GSM_GetAlarm	(	GSM_StateMachine *	s,
		GSM_Alarm *	Alarm
	)

Reads alarm set in phone.

Parameters

s	State machine pointer.
Alarm	Storage for alarm.

Returns: Error code

§ GSM_GetCalendar()

GSM_Error GSM_GetCalendar	(	GSM_StateMachine *	s,
		GSM_CalendarEntry *	Note
	)

Retrieves calendar entry.

Parameters

s	State machine pointer.
Note	Storage for note.

Returns: Error code

§ GSM_GetCalendarSettings()

GSM_Error GSM_GetCalendarSettings	(	GSM_StateMachine *	s,
		GSM_CalendarSettings *	settings
	)

Reads calendar settings.

Parameters

s	State machine pointer.
settings	Storage for settings.

Returns: Error code

§ GSM_GetCalendarStatus()

GSM_Error GSM_GetCalendarStatus	(	GSM_StateMachine *	s,
		GSM_CalendarStatus *	Status
	)

Retrieves calendar status (number of used entries).

Parameters

s	State machine pointer.
Status	Storage for status.

Returns: Error code

§ GSM_GetNextCalendar()

GSM_Error GSM_GetNextCalendar	(	GSM_StateMachine *	s,
		GSM_CalendarEntry *	Note,
		gboolean	start
	)

Retrieves calendar entry. This is useful for continuous reading of all calendar entries.

Parameters

s	State machine pointer.
Note	Storage for note, if start is FALSE, should contain data from previous read (at least position).
start	Whether we're doing initial read or continue in reading.

Returns: Error code

§ GSM_IsCalendarNoteFromThePast()

gboolean GSM_IsCalendarNoteFromThePast ( GSM_CalendarEntry * note )

Detects whether calendar note is in past.

Parameters

note	Note to check.

Returns: Whether entry is in past.

§ GSM_SetAlarm()

GSM_Error GSM_SetAlarm	(	GSM_StateMachine *	s,
		GSM_Alarm *	Alarm
	)

Sets alarm in phone.

Parameters

s	State machine pointer.
Alarm	Alarm to set.

Returns: Error code

§ GSM_SetCalendar()

GSM_Error GSM_SetCalendar	(	GSM_StateMachine *	s,
		GSM_CalendarEntry *	Note
	)

Sets calendar entry

Parameters

s	State machine pointer.
Note	New note values, needs to contain valid position.

Returns: Error code

§ GSM_SetCalendarSettings()

GSM_Error GSM_SetCalendarSettings	(	GSM_StateMachine *	s,
		GSM_CalendarSettings *	settings
	)

Sets calendar settings.

Parameters

s	State machine pointer.
settings	New calendar settings.

Returns: Error code

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

§ GSM_CalendarNoteType

§ GSM_CalendarType

§ GSM_VCalendarVersion

Function Documentation

§ GSM_AddCalendar()

§ GSM_CalendarFindDefaultTextTimeAlarmPhone()

§ GSM_DecodeVCALENDAR_VTODO()

§ GSM_DeleteAllCalendar()

§ GSM_DeleteCalendar()

§ GSM_EncodeVCALENDAR()

§ GSM_GetAlarm()

§ GSM_GetCalendar()

§ GSM_GetCalendarSettings()

§ GSM_GetCalendarStatus()

§ GSM_GetNextCalendar()

§ GSM_IsCalendarNoteFromThePast()

§ GSM_SetAlarm()

§ GSM_SetCalendar()

§ GSM_SetCalendarSettings()