JanamUtils is a plug-in extension that provides access to Janam XP20/XP30 hardware utility functions.

JXP_IsJanamXP - Return whether the current device is a Janam XP unit. Returns 0 if not a Janam XP, returns 20 if device is an XP20, returns 30 if device is an XP30.

USAGE: IsJanam=JXP_IsJanamXP()

JXP_KeyBacklight - Get or Set the Key Backlight setting on Janam XP units.

USAGE: result=JXP_KeyBacklight( Set, Enable )

Pass True for the Set parameter to Set the value, or False to Get the value. Pass True for the Enable parameter to enable the Key Backlight setting, or False to disable the Key Backlight setting (this parameter is used only when the Set parameter is True).

If Set is False, the function returns the current Key Backlight setting. If Set is True, the function returns False if there were no errors setting the Key Backlight value, True if there was an error.

JXP_5VPowerOut - Get or Set the 5V Power Out (used by MSR attachment) setting on Janam XP units.

USAGE: result=JXP_5VPowerOut( Set, Enable )

Pass True for the Set parameter to Set the value, or False to Get the value. Pass True for the Enable parameter to enable the 5V Power Out setting, or False to disable the 5V Power Out setting (this parameter is used only when the Set parameter is True).

If Set is False, the function returns the current 5V Power Out setting. If Set is True, the function returns False if there were no errors setting the 5V Power Out value, True if there was an error.

JXP_BuzzHiVolume - Get or Set the Buzz Hi Volume setting on Janam XP units.

USAGE: result=JXP_BuzzHiVolume( Set, Enable )

Pass True for the Set parameter to Set the value, or False to Get the value. Pass True for the Enable parameter to enable the Buzz Hi Volume setting, or False to disable the Buzz Hi Volume setting (this parameter is used only when the Set parameter is True).

If Set is False, the function returns the current 5V Power Out setting. If Set is True, the function returns False if there were no errors setting the Buzz Hi Volume value, True if there was an error.

JXP_Vibrator - Get or Set the Vibrator setting on Janam XP units.

USAGE: result=JXP_Vibrator( Set, Enable )

Pass True for the Set parameter to Set the value, or False to Get the value. Pass True for the Enable parameter to enable the Vibrator setting, or False to disable the Vibrator setting (this parameter is used only when the Set parameter is True).

If Set is False, the function returns the current Vibrator setting. If Set is True, the function returns False if there were no errors setting the Vibrator value, True if there was an error.

JXP_RedLED - Get or Set the Red LED setting on Janam XP units.

USAGE: result=JXP_RedLED( Set, Enable )

Pass True for the Set parameter to Set the value, or False to Get the value. Pass True for the Enable parameter to enable the Red LED setting, or False to disable the Red LED setting (this parameter is used only when the Set parameter is True).

If Set is False, the function returns the current Key Backlight setting. If Set is True, the function returns False if there were no errors setting the Red LED value, True if there was an error.

JXP_GreenLED - Get or Set the Green LED setting on Janam XP units.

USAGE: result=JXP_GreenLED( Set, Enable )

Pass True for the Set parameter to Set the value, or False to Get the value. Pass True for the Enable parameter to enable the Green LED setting, or False to disable the Green LED setting (this parameter is used only when the Set parameter is True).

If Set is False, the function returns the current Green LED setting. If Set is True, the function returns False if there were no errors setting the Green LED value, True if there was an error.

JXP_BTState - Get or Set the BT State (whether Bluetooth is enabled or not) setting on Janam XP units.

USAGE: result=JXP_BTState( Set, Enable )

Pass True for the Set parameter to Set the value, or False to Get the value. Pass True for the Enable parameter to enable the BT State setting, or False to disable the BT State setting (this parameter is used only when the Set parameter is True).

If Set is False, the function returns the current BT State setting. If Set is True, the function returns False if there were no errors setting the BT State value, True if there was an error.

DocID: 10201  DocDate: 2008-05-28