Power Service
[Telephony Mgr]

Detailed Description

This service groups the Telephony power functions.


Defines

#define ALP_TEL_IS_POW_GET_BATTERY_CHARGE_LEVEL_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_POW_GET_BATTERY_CHARGE_LEVEL_MESSAGE)
#define ALP_TEL_IS_POW_GET_BATTERY_CONNECTION_STATUS_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_POW_GET_BATTERY_CONNECTION_STATUS_MESSAGE)
#define ALP_TEL_IS_POW_GET_PHONE_FUNCTIONALITY_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_POW_GET_PHONE_FUNCTIONALITY_MESSAGE)
#define ALP_TEL_IS_POW_SET_PHONE_FUNCTIONALITY_SUPPORTED(iAppId)   alp_tel_is_function_supported(iAppId, ALP_TEL_POW_SET_PHONE_FUNCTIONALITY_MESSAGE)
#define ALP_TEL_POW_BATTERY_FAULT   3
 Power fault.
#define ALP_TEL_POW_BATTERY_NOT_POWERED   1
 ME has a battery connected, but is not powered by it.
#define ALP_TEL_POW_BATTERY_POWERED   0
 ME is powered by the battery.
#define ALP_TEL_POW_FUNCTIONALITY_FULL_LEVEL   0x01
#define ALP_TEL_POW_FUNCTIONALITY_MIN_LEVEL   0x00
#define ALP_TEL_POW_FUNCTIONALITY_NO_RX_LEVEL   0x03
#define ALP_TEL_POW_FUNCTIONALITY_NO_TX_LEVEL   0x02
#define ALP_TEL_POW_FUNCTIONALITY_NO_TX_NO_RX_LEVEL   0x04
#define ALP_TEL_POW_GET_BATTERY_CHARGE_LEVEL_MESSAGE   ((ALP_TEL_POW_SERVICE_ID << 8) | 0x0000)
#define ALP_TEL_POW_GET_BATTERY_CONNECTION_STATUS_MESSAGE   ((ALP_TEL_POW_SERVICE_ID << 8) | 0x0001)
#define ALP_TEL_POW_GET_PHONE_FUNCTIONALITY_MESSAGE   ((ALP_TEL_POW_SERVICE_ID << 8) | 0x0003)
#define ALP_TEL_POW_MASK_FUN_LEVEL   0x7F
 Mask to get the 'fun' power level.
#define ALP_TEL_POW_MASK_RESET   0x80
 Mask to get the 'rst' parameter.
#define ALP_TEL_POW_MESSAGES_COUNT   ((ALP_TEL_POW_GET_PHONE_FUNCTIONALITY_MESSAGE & ALP_TEL_MESSAGE_MASK) + 1)
 Total count of power service messages.
#define ALP_TEL_POW_NO_BATTERY   2
 ME does not have a battery connected.
#define ALP_TEL_POW_RESET   0x80
#define ALP_TEL_POW_SET_PHONE_FUNCTIONALITY_MESSAGE   ((ALP_TEL_POW_SERVICE_ID << 8) | 0x0002)

Functions

alp_status_t alp_tel_pow_get_battery_charge_level (AlpTelApplicationId iAppId, uint8_t *oBatteryChargeLevelP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_pow_get_battery_connection_status (AlpTelApplicationId iAppId, uint8_t *oBatteryConnectionStatusP, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_pow_get_phone_functionality (AlpTelApplicationId iAppId, uint8_t *oPhoneFunctionality, AlpTelTransId *ioTransIdP)
alp_status_t alp_tel_pow_set_phone_functionality (AlpTelApplicationId iAppId, uint8_t iPhoneFunctionality, AlpTelTransId *ioTransIdP)

Define Documentation

#define ALP_TEL_IS_POW_GET_BATTERY_CHARGE_LEVEL_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_POW_GET_BATTERY_CHARGE_LEVEL_MESSAGE)
 

#define ALP_TEL_IS_POW_GET_BATTERY_CONNECTION_STATUS_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_POW_GET_BATTERY_CONNECTION_STATUS_MESSAGE)
 

#define ALP_TEL_IS_POW_GET_PHONE_FUNCTIONALITY_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_POW_GET_PHONE_FUNCTIONALITY_MESSAGE)
 

#define ALP_TEL_IS_POW_SET_PHONE_FUNCTIONALITY_SUPPORTED (  iAppId   )     alp_tel_is_function_supported(iAppId, ALP_TEL_POW_SET_PHONE_FUNCTIONALITY_MESSAGE)
 

#define ALP_TEL_POW_BATTERY_FAULT   3
 

Power fault.

#define ALP_TEL_POW_BATTERY_NOT_POWERED   1
 

ME has a battery connected, but is not powered by it.

#define ALP_TEL_POW_BATTERY_POWERED   0
 

ME is powered by the battery.

#define ALP_TEL_POW_FUNCTIONALITY_FULL_LEVEL   0x01
 

#define ALP_TEL_POW_FUNCTIONALITY_MIN_LEVEL   0x00
 

#define ALP_TEL_POW_FUNCTIONALITY_NO_RX_LEVEL   0x03
 

#define ALP_TEL_POW_FUNCTIONALITY_NO_TX_LEVEL   0x02
 

#define ALP_TEL_POW_FUNCTIONALITY_NO_TX_NO_RX_LEVEL   0x04
 

#define ALP_TEL_POW_GET_BATTERY_CHARGE_LEVEL_MESSAGE   ((ALP_TEL_POW_SERVICE_ID << 8) | 0x0000)
 

#define ALP_TEL_POW_GET_BATTERY_CONNECTION_STATUS_MESSAGE   ((ALP_TEL_POW_SERVICE_ID << 8) | 0x0001)
 

#define ALP_TEL_POW_GET_PHONE_FUNCTIONALITY_MESSAGE   ((ALP_TEL_POW_SERVICE_ID << 8) | 0x0003)
 

#define ALP_TEL_POW_MASK_FUN_LEVEL   0x7F
 

Mask to get the 'fun' power level.

#define ALP_TEL_POW_MASK_RESET   0x80
 

Mask to get the 'rst' parameter.

#define ALP_TEL_POW_MESSAGES_COUNT   ((ALP_TEL_POW_GET_PHONE_FUNCTIONALITY_MESSAGE & ALP_TEL_MESSAGE_MASK) + 1)
 

Total count of power service messages.

#define ALP_TEL_POW_NO_BATTERY   2
 

ME does not have a battery connected.

#define ALP_TEL_POW_RESET   0x80
 

#define ALP_TEL_POW_SET_PHONE_FUNCTIONALITY_MESSAGE   ((ALP_TEL_POW_SERVICE_ID << 8) | 0x0002)
 

Function Documentation

alp_status_t alp_tel_pow_get_battery_charge_level (  AlpTelApplicationId  iAppId,
uint8_t *  oBatteryChargeLevelP,
AlpTelTransId *  ioTransIdP
) 
 

Gets the current level of the phone battery, as a percentage value.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[out] oBatteryChargeLevelP Pointer to a value that indicates the battery percentage level as an integer value between 0 and 100.
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The battery charge level has been changed successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_pow_get_battery_connection_status (  AlpTelApplicationId  iAppId,
uint8_t *  oBatteryConnectionStatusP,
AlpTelTransId *  ioTransIdP
) 
 

Gets the status of the phone battery.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[out] oBatteryConnectionStatusP Pointer to the battery status value. One of the constant ALP_TEL_POW_XXX.
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The battery connection status has been changed successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_pow_get_phone_functionality (  AlpTelApplicationId  iAppId,
uint8_t *  oPhoneFunctionality,
AlpTelTransId *  ioTransIdP
) 
 

Get the level of functionality of the phone.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[in,out] oPhoneFunctionality A pointer to receive the current phone functionnality (constant)
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The phone functionqlity level has been get successfuly.
Since:
ALP iSDK 1.0

alp_status_t alp_tel_pow_set_phone_functionality (  AlpTelApplicationId  iAppId,
uint8_t  iPhoneFunctionality,
AlpTelTransId *  ioTransIdP
) 
 

Set the level of functionality of the phone.

Parameters:
[in] iAppId The telephone application attachement identifier for your application.
[out] iPhoneFunctionality Specify one of the constant TODO
[in,out] ioTransIdP Set the value of this parameter to NULL to cause the function to execute synchronously. If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation.
Returns:
ALP_STATUS_OK The phone functionqlity level has been set successfuly.
Since:
ALP iSDK 1.0

Generated on Wed Jul 30 07:06:43 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.