include/gammu-settings.h

   1 /**
   2  * \file gammu-settings.h
   3  * \author Michal Čihař
   4  *
   5  * Phone settings data and functions.
   6  */
   7 #ifndef __gammu_settings_h
   8 #define __gammu_settings_h
   9
  10 /**
  11  * \defgroup Settings Settings
  12  * Phone settings manipulations.
  13  */
  14
  15 #include <gammu-wap.h>
  16 #include <gammu-limits.h>
  17
  18 typedef struct {
  19         int Location;
  20         gboolean Active;
  21         gboolean SyncPhonebook;
  22         gboolean SyncCalendar;
  23         char Name[(20 + 1) * 2];
  24         char PhonebookDataBase[(50 + 1) * 2];
  25         char CalendarDataBase[(50 + 1) * 2];
  26         char User[(30 + 1) * 2];
  27         char Password[(20 + 1) * 2];
  28         char Server[(128 + 1) * 2];
  29         GSM_MultiWAPSettings Connection;
  30 } GSM_SyncMLSettings;
  31
  32 /* ------------------------------------------------------------------------ */
  33
  34 typedef enum {
  35         GSM_RESET_PHONESETTINGS = 1,
  36         GSM_RESET_USERINTERFACE,
  37         GSM_RESET_USERINTERFACE_PHONESETTINGS,
  38         GSM_RESET_DEVICE,
  39         GSM_RESET_FULLFACTORY
  40 } GSM_ResetSettingsType;
  41
  42 typedef struct {
  43         char Name[(50 + 1) * 2];
  44         char HomePage[(200 + 1) * 2];
  45         char User[(50 + 1) * 2];
  46         char Password[(50 + 1) * 2];
  47         int Location;
  48         gboolean Active;
  49         GSM_MultiWAPSettings Connection;
  50 } GSM_ChatSettings;
  51
  52 typedef enum {
  53         PROFILE_KEYPAD_LEVEL1 = 1,
  54         PROFILE_KEYPAD_LEVEL2,
  55         PROFILE_KEYPAD_LEVEL3,
  56         PROFILE_KEYPAD_OFF,
  57         PROFILE_CALLALERT_RINGING,
  58         PROFILE_CALLALERT_BEEPONCE,
  59         PROFILE_CALLALERT_OFF,
  60         PROFILE_CALLALERT_RINGONCE,
  61         PROFILE_CALLALERT_ASCENDING,
  62         PROFILE_CALLALERT_CALLERGROUPS,
  63         PROFILE_VOLUME_LEVEL1,
  64         PROFILE_VOLUME_LEVEL2,
  65         PROFILE_VOLUME_LEVEL3,
  66         PROFILE_VOLUME_LEVEL4,
  67         PROFILE_VOLUME_LEVEL5,
  68         PROFILE_MESSAGE_NOTONE,
  69         PROFILE_MESSAGE_STANDARD,
  70         PROFILE_MESSAGE_SPECIAL,
  71         PROFILE_MESSAGE_BEEPONCE,
  72         PROFILE_MESSAGE_ASCENDING,
  73         PROFILE_MESSAGE_PERSONAL,
  74         PROFILE_VIBRATION_OFF,
  75         PROFILE_VIBRATION_ON,
  76         PROFILE_VIBRATION_FIRST,
  77         PROFILE_WARNING_ON,
  78         PROFILE_WARNING_OFF,
  79         PROFILE_AUTOANSWER_ON,
  80         PROFILE_AUTOANSWER_OFF,
  81         PROFILE_LIGHTS_OFF,
  82         PROFILE_LIGHTS_AUTO,
  83         PROFILE_SAVER_ON,
  84         PROFILE_SAVER_OFF,
  85         PROFILE_SAVER_TIMEOUT_5SEC,
  86         PROFILE_SAVER_TIMEOUT_20SEC,
  87         PROFILE_SAVER_TIMEOUT_1MIN,
  88         PROFILE_SAVER_TIMEOUT_2MIN,
  89         PROFILE_SAVER_TIMEOUT_5MIN,
  90         PROFILE_SAVER_TIMEOUT_10MIN
  91 } GSM_Profile_Feat_Value;
  92
  93 typedef enum {
  94         Profile_KeypadTone = 1,
  95         Profile_CallAlert,
  96         Profile_RingtoneVolume,
  97         Profile_MessageTone,
  98         Profile_Vibration,
  99         Profile_WarningTone,
 100         Profile_AutoAnswer,
 101         Profile_Lights,
 102         Profile_ScreenSaverTime,
 103         Profile_ScreenSaver,
 104
 105         Profile_ScreenSaverNumber,
 106         Profile_RingtoneID,
 107         Profile_MessageToneID,
 108         Profile_CallerGroups
 109 } GSM_Profile_Feat_ID;
 110
 111 /**
 112  * It contains phone profiles
 113  */
 114 typedef struct {
 115         gboolean Active;
 116
 117         /**
 118          * Profile number
 119          */
 120         int Location;
 121         /**
 122          * Profile name
 123          */
 124         char Name[40 * 2];
 125         /**
 126          * Is it default name for profile ?
 127          */
 128         gboolean DefaultName;
 129         gboolean HeadSetProfile;
 130         gboolean CarKitProfile;
 131
 132         int FeaturesNumber;
 133         GSM_Profile_Feat_Value FeatureValue[15];
 134         GSM_Profile_Feat_ID FeatureID[15];
 135
 136         gboolean CallerGroups[5];
 137 } GSM_Profile;
 138
 139 typedef struct {
 140         int Location;
 141         double Frequency;
 142         char StationName[(GSM_MAX_FMSTATION_LENGTH + 1) * 2];
 143 } GSM_FMStation;
 144
 145 typedef struct {
 146         int Location;
 147         gboolean Active;
 148         unsigned char Name[(GSM_MAX_GPRS_AP_NAME_LENGTH + 1) * 2];
 149         unsigned char URL[(GSM_MAX_GPRS_AP_URL_LENGTH + 1) * 2];
 150 } GSM_GPRSAccessPoint;
 151
 152 typedef enum {
 153         GSM_Date_DDMMYYYY = 1,
 154         GSM_Date_MMDDYYYY,
 155         GSM_Date_YYYYMMDD,
 156         GSM_Date_DDMMMYY,
 157         GSM_Date_MMDDYY,
 158         GSM_Date_DDMMYY,
 159         GSM_Date_YYMMDD,
 160         GSM_Date_OFF
 161 } GSM_DateFormat;
 162
 163 typedef struct {
 164         char DateSeparator;
 165         GSM_DateFormat DateFormat;
 166         gboolean AMPMTime;
 167 } GSM_Locale;
 168
 169 typedef struct {
 170         GSM_Profile_Feat_ID ID;
 171         GSM_Profile_Feat_Value Value;
 172         unsigned char PhoneID;
 173         unsigned char PhoneValue;
 174 } GSM_Profile_PhoneTableValue;
 175
 176 /**
 177  * Gets locale from phone.
 178  */
 179 GSM_Error GSM_GetLocale(GSM_StateMachine * s, GSM_Locale * locale);
 180
 181 /**
 182  * Sets locale of phone.
 183  */
 184 GSM_Error GSM_SetLocale(GSM_StateMachine * s, GSM_Locale * locale);
 185
 186 /**
 187  * Acquires SyncML settings.
 188  */
 189 GSM_Error GSM_GetSyncMLSettings(GSM_StateMachine * s,
 190                                 GSM_SyncMLSettings * settings);
 191 /**
 192  * Changes SyncML settings.
 193  */
 194 GSM_Error GSM_SetSyncMLSettings(GSM_StateMachine * s,
 195                                 GSM_SyncMLSettings * settings);
 196 /**
 197  * Acquires chat/presence settings.
 198  */
 199 GSM_Error GSM_GetChatSettings(GSM_StateMachine * s,
 200                               GSM_ChatSettings * settings);
 201 /**
 202  * Changes chat/presence settings.
 203  */
 204 GSM_Error GSM_SetChatSettings(GSM_StateMachine * s,
 205                               GSM_ChatSettings * settings);
 206 /**
 207  * Acquires MMS settings.
 208  */
 209 GSM_Error GSM_GetMMSSettings(GSM_StateMachine * s,
 210                              GSM_MultiWAPSettings * settings);
 211 /**
 212  * Changes MMS settings.
 213  */
 214 GSM_Error GSM_SetMMSSettings(GSM_StateMachine * s,
 215                              GSM_MultiWAPSettings * settings);
 216 /**
 217  * Enables network auto login.
 218  */
 219 GSM_Error GSM_SetAutoNetworkLogin(GSM_StateMachine * s);
 220
 221 /**
 222  * Performs phone reset.
 223  */
 224 GSM_Error GSM_Reset(GSM_StateMachine * s, gboolean hard);
 225
 226 /**
 227  * Resets phone settings.
 228  */
 229 GSM_Error GSM_ResetPhoneSettings(GSM_StateMachine * s,
 230                                  GSM_ResetSettingsType Type);
 231 /**
 232  * Reads profile.
 233  */
 234 GSM_Error GSM_GetProfile(GSM_StateMachine * s, GSM_Profile * Profile);
 235
 236 /**
 237  * Updates profile.
 238  */
 239 GSM_Error GSM_SetProfile(GSM_StateMachine * s, GSM_Profile * Profile);
 240
 241 /**
 242  * Reads FM station.
 243  */
 244 GSM_Error GSM_GetFMStation(GSM_StateMachine * s, GSM_FMStation * FMStation);
 245
 246 /**
 247  * Sets FM station.
 248  */
 249 GSM_Error GSM_SetFMStation(GSM_StateMachine * s, GSM_FMStation * FMStation);
 250
 251 /**
 252  * Clears defined FM stations.
 253  */
 254 GSM_Error GSM_ClearFMStations(GSM_StateMachine * s);
 255
 256 /**
 257  * Gets GPRS access point.
 258  */
 259 GSM_Error GSM_GetGPRSAccessPoint(GSM_StateMachine * s,
 260                                  GSM_GPRSAccessPoint * point);
 261 /**
 262  * Sets GPRS access point.
 263  */
 264 GSM_Error GSM_SetGPRSAccessPoint(GSM_StateMachine * s,
 265                                  GSM_GPRSAccessPoint * point);
 266 #endif
 267
 268 /* Editor configuration
 269  * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 270  */