_äìé`çêé» BlueVOX2 Configurator. User Guide. September Part of the BlueVOX2 Audio Solution

Transcription

1 _äìé`çêé» BlueVOX2 Configurator User Guide September 2006 CSR Cambridge Science Park Milton Road Cambridge CB4 0WH United Kingdom Registered in England Part of the BlueVOX2 Audio Solution Tel: +44 (0) Fax: +44 (0)

2 Contents Contents 1 Introduction General Description of BlueVOX Configurator Workspace Functionality File Menu Output Menu Properties Menu View Menu Help Menu Opening a Default Configuration Advanced Configuration Parameters EEPROM Initialisation Downloading Persistent Store Values to EEPROM Document References Appendix A A.1 Battery Configuration A.2 Button Configuration A.3 Button Sequence Configuration A.4 Supported Features A.5 PIO Input Configuration A.6 HFP 1.5 Feature Configuration A.7 Enabling HFP 1.5 Support A.8 Headset Timeouts A.9 Radio Configuration A.10 NiMH Charger Configuration A.11 Feature Configuration A.12 Audio Gain Mapping A.13 LED State Configuration A.14 LED Event Configuration A.15 LED Filter Configuration A.16 Event Configuration A.17 Tone Configuration A.18 PIO Output Configuration A.19 Tri Colour LED Information A.20 Power Table Settings Appendix B BlueVOX2 System Events Appendix C BlueVOX2 Tones Appendix D BlueVOX2 Headset States Terms and Definitions Document History Page 2 of 58

3 Introduction 1 Introduction BlueVOX is the generic name for CSR s mono headset solutions. BlueVOX provides a fast-track Bluetooth headset solution allowing manufacturers to rapidly develop their own unique mono headset designs. This document describes BlueVOX2 Configurator. BlueVOX2 Configurator is a user-friendly tool developed to configure the Headset V4 and Headset V4 Refresh mono headset software to suit the manufacture s Human Machine Interface (HMI) design. The Headset v4 and Headset v4 Refresh software is designed to run on CSR s BlueCore4-Audio ROM and BlueCore3-Audio Flash chips. Note: BlueCore4-Audio ROM implementations require an external EEPROM to store the Persistent Store values that configure the HMI. Chapter 5 describes how to initialise the EEPROM for use with the Headset V4 software. To allow manufacturers to distinguish their final product in the market place the Headset v4 and Headset V4 Refresh software is designed with a highly configurable HMI. Developers can readily: Define PIO functionality to suit their hardware design. Associate device control with different button configurations. Define unique LED patterns and audio tones to indicate: User actions System states System events 1.1 General The BlueVOX Configurator can be used to customise the full range of Headset v4 and Headset V4 Refresh HMI settings. PS Key configuration settings can be read into the BlueVOX Configurator from the default options, a previously saved user-generated.psr file or a connected device. Default configurations are provided for two, three and four-button headset designs. When BlueVOX Configurator is opened, developers can select the button configuration that matches their hardware design and suitable default settings for the selected hardware design are loaded into the BlueVOX Configurator application. Note: The default button assignment, functionality and user events can then be viewed in the User Events tab. The default settings provide a viable HMI that can be used as supplied or can be customised, by the manufacturer, using the BlueVOX Configurator advanced option. Settings defined in the BlueVOX Configurator can be saved as a.psr file or downloaded directly to the Persistent Store of a connected device. Page 3 of 58

4 Description of BlueVOX Configurator Workspace 2 Description of BlueVOX Configurator Workspace BlueVox Configurator supports two modes of operation: Simple mode: allows configuration values for default two, three and four-button headsets to be loaded into the BlueVOX Configurator, and the input and output PIOs corresponding to the hardware design to be assigned. Advanced mode: allows developers access to the full range of configuration parameters supported by the Headset V4 software. The configuration parameters in BlueVOX Configurator can be wriiten to a.psr file or downloaded to a connected device in both modes. Menu Bar Buttons Workspace Debug Output Pane Page 4 of 58

5 Description of BlueVOX Configurator Workspace 2.1 Functionality The full functionality provided by BlueVOX Configurator is accessed through menus in the menu bar. Buttons are also provided to support the most commonly required functions. This section describes the menus, menu items and their functions File Menu The File menu contains: Open from Device: loads the configuration settings on a connected device into the BlueVOX Configurator and displays them in the advanced view. Note: A suitable connection to the device is required and the appropriate transport method must be set using Transport from the Properties menu. See section Open from Default: loads configuration parameters for the default button options listed in a submenu: Open Two Button: loads default configuration settings for a two-button headset into BlueVOX Configurator. Open Three Button: loads default configuration settings for a three-button headset into BlueVOX Configurator. Open Four Button: loads default configuration settings for a four-button headset into BlueVOX Configurator. Open from PSR file: loads configuration settings from a.psr file. An Open dialogue box allows the user to browse to a location and select the.psr file to be used. Exit: Closes the BlueVOX Configurator application. Note: Exit does not automatically save changes made to values in the BlueVOX Configurator. Buttons displayed on the left of the BlueVOX Configurator application window also provide Open from Default, Open from File and Open from Device functionality Output Menu The Output menu contains: Write PSR File: Allows the currently displayed settings to be saved as a.psr file. Note: A Save As dialogue opens. Select the location to save the file and enter a filename then click Save to write the.psr file to the selected location. Write to Device: Downloads the currently displayed settings to a connected device. Note: A suitable connection to the device is required and the appropriate transport method must be set using Transport from the Properties menu. See section Buttons displayed on the left of the BlueVOX Configurator application window also provide Write PSR and Write Device functionality. Page 5 of 58

6 Description of BlueVOX Configurator Workspace Properties Menu The Properties menu contains: Transport: Allows the transport protocol used to communicate with a connected BlueCore device to be defined. Selecting Transport opens a Choose Transport window: Note: The application s default transport as shipped is BCSP, Serial Port Com1 and Baud Rate If the Transport method is changed, the newly applied transport method is retained until manually changed View Menu The View menu contains: Advanced: Select this option to display the additional tabs available for advanced configuration. The advanced configuration tabs can also be accessed using the Advanced View button Help Menu The Help menu contains: About: Displays version information about the BlueVOX Configurator. Page 6 of 58

7 Opening a Default Configuration 3 Opening a Default Configuration When BlueVOX Configurator is opened for the first time, a simple view of the application is displayed. Note: Subsequently BlueVOX Configurator opens in the simple or advanced view depending on the active mode when the application is closed. To open a default configuration for a two, three or four-button device select the required option button on the left of the Configurator screen. The default settings are loaded into the BlueVOX Configurator and displayed in the simple view: The simple view provides access to a subset of the configuration parameters that allow engineers to set output and input PIOs to match their hardware design and to select the the device platform, V4 version or V4 Refresh version. A view-only User Events tab allows the engineer to see details of the user event configuration. To adjust these or other configuration settings click the Advanced View button. Page 7 of 58

8 Advanced Configuration Parameters 4 Advanced Configuration Parameters To access the full range of configuration options click the Advanced View button or select Advanced from the View menu. The advanced view includes 11 tabs that group related configuration parameters and provide a user-friendly interface. When set as required, parameters configured in the BlueVOX Configurator can be written to a.psr file or downloaded directly to a connected device. The parameters set in the BlueVOX Configurator tabs map to PS Keys that control the Headset v4 software s HMI configuration. The PS Keys and the parameters they hold are described in Appendix A To edit User Event, Leds (States), Leds (Events), Leds (Filter) and Audio Tones tabs click on an entry. An editor window opens allowing an existing entry to be adjusted or a new entry created. Page 8 of 58

9 EEPROM Initialisation 5 EEPROM Initialisation When using BlueCore4-Audio ROM to implement the Headset v4 software, a small external EEPROM is required to store the HMI configuration data. This chapter describes how to initialise the EEPROM so that BlueCore can read and write data to the EEPROM correctly. The development engineer must write a special header into the EEPROM to inform the BlueCore device which type of EEPROM is being used. Note: CSR s BlueCore4-Audio ROM is compatible with EEPROM devices from many different manufacturers and with many different capacities. e2write is a command line application that initialises an external EEPROM. e2write is included in the BlueSuite Development Tools download available from the Headset section of The syntax for this application is: e2write DEVICE Log2Bytes AddrMask For I 2 C EEPROM devices manufactured by ST, Rohm and Microchip, the appropriate Log2Bytes AddrMask parameters depend on the memory capacity shown in Table 5.1. Device size (kbit) Device e2_device parameters Manufacturer Part number Log2Bytes AddrMask 16 Rohm BR24E16 ST ST24E16 ST25E16 24AA Microchip 24LC515 24FC Table 5.1: e2write Parameters for EEPROMs Manufactured by Rohm, ST and Microchip For all other common EEPROM devices, the Log2Bytes AddrMask parameters depend on the memory capacity shown in Table 5.2. e2_device Parameters Device size (kbit) Log2Bytes AddrMask Table 5.2: e2write Parameters for EEPROMs from All Other Manufacturers Page 9 of 58

10 EEPROM Initialisation To initialise the EEPROM: 1. Download the BlueSuite Development Tools from the Headset section of Unzip the downloaded file into a new folder. 2. Power On the headset board. 3. Make an SPI connection between the headset board and the parallel port of the PC (also known as the printer port). 4. Open a command prompt and change directory to the folder containing the e2write application. 5. Look up the correct values of Log2Bytes and AddrMask for the EEPROM device. Refer to Table 5.1 and Table 5.2 for details. 6. Enter the e2write syntax replacing Log2Bytes and AddrMask with the correct values for the appropriate EEPROM device. For example, to initialise an ST24E16 EEPROM device enter: e2write -DEVICE 11 0 The EEPROM is now initialised and is suitable for use as the Persistent Store. 5.1 Downloading Persistent Store Values to EEPROM When the EEPROM is initialised, the Persistent Store settings for the headset can be downloaded to it. This is done using the PSTool utility. Both the system.psr file and the HMI.psr file generated using BlueVOX Configurator must be downloaded. Note: The PSTool utility is shipped as part of BlueLab or can be downloaded from the CSR support website. To download the Persistent Store settings: 1. Make an SPI connection to the headset board. 2. Open the PSTool utility. 3. Select SPI BCCMD and the port to connect to in the Choose Transport dialogue. Click OK. 4. Select Merge from the File Menu and select the system.psr file to be downloaded. Click Open. Repeat to download the HMI.psr file. Note: The system.psr file is located in the BlueVOX Configurator install directory. A more detailed description of the PSTool utility and the merge facility is available in the PSTool User Guide (CSR ref: blab-ug-008p) which can be downloaded from Page 10 of 58

11 Document References 6 Document References Document PSTool User Guide BlueVOX QuickStart Guide BlueCore4-Headset Software Release Note Headset V4 BlueCore4-Headset Software Release Note Headset V4 Refresh RC4 Reference blab-ug-008p bcore-ug-016p bcore-srn-081p bcore-srn-087p Page 11 of 58

12 Appendix A Table 5.1 describes the Persistent Store Keys dedicated to the configuration in the Bluecore4-Headset application. PS Key Description Units Valid Range Default Value Notes USR0 Battery Structure See Appendix A.1. Configuration USR1 Button Configuration Structure See Appendix A.2. USR2 Button Sequence Structure See Appendix A.3. Configuration USR3 HFP Supported uint16 See Appendix A.4. Features USR4 PIO Input Uint16 See Appendix A.5. configuration USR5 HFP 1.5 Features Structure See Appendix A.6. Enabled USR6 Timers/Counters structure See Appendix A.8 USR7 Unused n/a n/a n/a n/a USR8 Unused n/a n/a n/a n/a USR9 Unused n/a n/a n/a n/a USR10 Stores whether the vol buttons are inverted or not True/false false This key is written to by the application when the volume orientation is changed i.e. to allow users to swap the vol+ and vol- buttons. USR11 Unused n/a n/a n/a n/a USR12 Unused n/a n/a n/a n/a USR13 Radio Configuration Structure See Appendix A.9. USR14 NiMH Battery Structure See Appendix A.10. Charger Configuration USR15 Feature Structure See Appendix A.11. Configuration USR16 Audio Gain Mapping Structure See Appendix A.12. USR17 Number of LED Filters Integer Defines the number of LED filters used by the application, see Appendix A.15. USR18 LED Filter Definition Structure See Appendix A.15. USR19 Number of LED State Definitions Integer Defines the number of LED States used by the application. See Appendix A.13. USR20 LED State Definition Structure See Appendix A.13. USR21 Number of LED Event Definitions Integer Defines the number of LED Events. See Appendix A.14. USR22 LED Event Definitions Structure See Appendix A.14. Page 12 of 58

13 PS Key Description Units Valid Range Default Value Notes USR23 USR24 USR25 USR26 System Event Configuration A System Event Configuration B Number of Event Tones Event Tone configuration Structure Defines configuration of up to 20 System Events. See Appendix A.16. Structure Defines configuration of up to another 20 System Events. See Appendix A.16. Integer Stores the number of Event Tones defined in USR26. Structure See Appendix A.17. USR27 PIO Output Setup Structure See Appendix A.18. USR28 Tri colour LED Structure See Appendix A.19. information USR29 Last Used AG BDADDR Stores the Bluetooth Address of the last device connected with the headset. USR30 Default AG BDADDR Stores the Bluetooth Address of the first device paired with the headset (after the last reset). USR31 Configuration ID Integer Holds the ID of the required default configuration stored in constant space. HFP_POWER_TABLE Power Table Settings Structure See Appendix A.20. Table A.1: used for BlueVox2 Page 13 of 58

14 A.1 Battery Configuration PS Key USR0 holds data defining the battery monitoring parameters. The parameters are held in the following bit fields: Label Divider Ratio Minimum Threshold Shutdown Threshold Gas Gauge Level 1 Type uint16 uint16 (D15-D8) (D7-D0) uint16 (D15-D8) Range , (mv in +20mV steps) (mv in +20mV steps) mV (mv in +20mV steps) Default Value 405 (0x0195) 165 (0x00a5) 150 (0x0096) 170 (0x00aa) Gas Gauge Level 2 Gas Gauge Level 3 Unused Monitoring period Reminder Time (D7-D0) uint16 (D15-D8) (D7-D0) uint16 (D15-D8) (D7-D0) mV (mv in mV (mv in secs secs +20mV steps) +20mV steps) 185 (0x00b9) 200 (0x00c8) 0 30 (0x001e) 5 (0x0005) Notes: (1) (2) (3) (4) (5) (6) (7) Table A.2: PS Key USR0 Battery Configuration Bit Fields The Battery monitoring will occur every Monitoring Period time. If the battery voltage is below Shutdown threshold then the headset will perform a clean disconnect and will power off. If the battery voltage is above Shutdown threshold and below Minimum threshold then eventbatterylow will be reported. If the battery voltage is above Minimum threshold and below Gas Gauge Level 1 then the headset will report eventbatteryok and EventGasGauge0 If the battery voltage is above Gas Gauge Level 1 and below Gas Gauge Level 2 then the headset will report eventbatteryok and EventGasGauge1 If the battery voltage is above Gas Gauge Level 2 and below Gas Gauge Level 3 then the headset will report eventbatteryok and EventGasGauge2 If the battery voltage is above Gas Gauge Level 3 then the headset will report eventbatteryok and EventGasGauge3 Page 14 of 58

15 A.2 Button Configuration PS Key USR1 holds data that configures button press definitions. The parameters are held in the following bit fields: Label Double Press Time Long Press Time Very Long Press Time Repeat Time Very Very Long PressTime Type uint16 uint16 uint16 uint16 uint16 Range (ms) (ms) (ms) (ms) (ms) Default Value 500 (0x01f4) 1000 (0x03e8) (0x0dac) 800 (0x0320) 5000 (0x1388) Table A.3: PS Key USR1 Button Configuration Bit Fields Note: Default values quoted are for Headset v4 four button configuration. A.3 Button Sequence Configuration PS Key USR2 allows two sequences of up to six button presses to be defined and used to generate a system event. Every time a PIO is pressed the code checks for a match to the defined pattern. If the sequence of button presses matches the sequence in the key then the specified event is sent to the main message loop. Note: There is no limit to the time between button presses and no distinction is made between short or long button presses. The key can contain up to two event sequences in the form: Label Event to be Generated Key 1 Key 2 Key 3 Key 4 Key 5 Key 6 Type uint16 uint16 uint16 uint16 uint16 uint16 uint16 Range Default Value Example 0x6001-0x603f Set bit pattern for required button press sequence N/a N/a N/a N/a N/a N/a N/a Table A.4: PS Key USR2 Button Sequence Configuration Bit Fields To configure the event EventEnterDUTmode as a result of 6 presses of PIO[0] the key would hold the hex value: The second sequence is not used in this example and is initialised to 0. Note: Normal system events should be configured using PS Keys USR23 and USR24. See A.15 Event Configuration. Page 15 of 58

16 A.4 Supported Features PS Key USR3 maps directly onto the supported features reported as part of the AT+BRSF command used during registration and connection setup sequence. A 16-bit unsigned integer bitmask is used to report support for the following features: Example #define HFP_NREC_FUNCTION (1) #define HFP_THREE_WAY_CALLING (1<<1) #define HFP_CLI_PRESENTATION (1<<2) #define HFP_VOICE_RECOGNITION (1<<3) #define HFP_REMOTE_VOL_CONTROL (1<<4) #define HFP_ENHANCED_CALL_STATUS (1<<5) #define HFP_ENHANCED_CALL_CONTROL (1<<6) To indicate support for three way calling and remote voice control the bitmask would be set as: (i.e.hex value 000a) A.5 PIO Input Configuration PS Key USR4 configures the PIOs to be used to trigger a charger event or to put the device into DUT (Device Under Test) mode on power on. The PS Key specifies the PIO which when held high indicates the event. Label Reserved Reserved Charger Input PIO DUT Mode PIO Type uint16 (D15-12) (D11-8) (D7-4) (D3-0) Range Not used Not used 0-11 (0x0-0xb) 0-11 (0x0-0xb) Default Value 0xf (not used) 0xf (not used) 0xf (not used) 0xf (not used) Table A.5: PS Key USR4 PIO Input Configuration Bit Fields Note: Default values quoted are for Headset v4 four-button configuration. Description of Bit Fields Charger Input PIO: the pin specified in this field is polled on power up. If the pin is held high it indicates that the charger is connected and the charger event message will be received by the application. Note: Charger events still need to be configured for charging indications such as LED patterns etc. DUT Mode PIO: when the pin specified in this field is held high on power on the device enters Device under Test mode. This feature can be useful during production line testing. Example To configure PIO[0] as the Charger Input PIO and PIO[11] as the DUT Mode, PS Key USR4 would hold the hex value: ff0b Page 16 of 58

17 A.6 HFP 1.5 Feature Configuration PS Key USR5 must be set when developing a device that will support version 1.5 of the Handsfree Profile (HFP 1.5). The feature configuration data is held in the following bit fields: Label Type Values Is HFP 1.5 Enabled uint16 (D15) 0x1 enabled 0x0 disabled Reserved Additional Params Used Audio Sync Packet Types Bandwidth Max Latency Voice Settings (D14-1) (D0) uint16 uint32 uint16 uint16 uint16 n/a Audio Packet Types Bitmask See Audio Packet Types Bitmask Table A.6: PS Key USR4 HFP 1.5 Feature Configuration Bit Fields Retransmission Effort This bitmask is used for SCO/eSCO negotiation. The headset will automatically negotiate the best audio package type that can be achieved from the activated package types. Bit D15 D14 D13 D12 D11 D10 D9 D8 Packet Type reserved reserved reserved reserved reserved reserved sync_3ev5 sync_3ev3 Mask Value n/a n/a n/a n/a n/a n/a 0x0200 0x0100 D7 D6 D5 D4 D3 D2 D1 D0 sync_2ev5 sync_2ev3 sync_ev5 sync_ev4 sync_ev3 sync_hv3 sync_hv2 sync_hv1 0x0080 0x0040 0x0020 0x0010 0x0008 0x0004 0x0002 0x0001 Table A.7: PS Key USR5 Audio Packet Type Bitmask Bit = 1: The packet type will be included in audio negotiation. Note: esco packet types are only available if HFP 1.5 support is enabled see below. Bit = 0: The packet type will not be included in audio negotiation. IMPORTANT NOTE: The enable bits are inverted for D6, D7, D8, and D9 i.e. 0 = included in audio negotiation, 1 = not included in audio negotiation. Page 17 of 58

18 A.7 Enabling HFP 1.5 Support To enable HFP 1.5 support, an additional PS Key must also be set. If the BlueVOX Configurator HFP Features tab is used to configure the Audio Packet Types and the Enable HFP 1.5 Features option is checked this key is written automatically. To enable HFP 1.5 if USR5 is set manually, the following PS Key must also be set manually: To enable esco EV3, EV4 and EV5: PS Key LOCAL_SUPPORTED_FEATURES = fefc 800f 880b 0000 To enable esco plus 2M EDR: PS Key LOCAL_SUPPORTED_FEATURES = fefc 800f A80b 0000 To enable esco plus 3M EDR: PS Key LOCAL_SUPPORTED_FEATURES = fefc 800f E80b 0000 If HFP 1.5 support is not required the value should be: PS Key LOCAL_SUPPORTED_FEATURES = fefc 000f Retransmission Effort Enumeration values: sync_retx_disabled No retransmissions. sync_retx_power_usage At least one retransmission, optimise for power consumption. sync_retx_link_quality At least one retransmission, optimise for link quality. sync_retx_dont_care Don't care. Example The following entry: in PS Key USER5 configures: f f40 000c esco enabled all packet types supported 8000Hz Bandwidth latency of 12 retransmission effort = link quality Headset with esco enabled, all packet types supported 8000Hz Bandwidth latency of 12 and retransmision effort = link quality Page 18 of 58

19 A.8 Headset Timeouts PS Key USR6 configures the Timers and Counters used in the application. Label AutoSwitchOffTime_s AutoPowerOnTimeout_s NetworkServiceIndicatorRepeatTime_s Type uint16 uint16 uint16 uint16 uint16 uint16 uint16 uint16 Range Default Value (secs) 600 (0x0258) 0-60 (secs) 12 (0x000c) Description of Timers and Counters (secs) 10 (0x000a) DisablePowerOffAfterPowerOnTime_s 0-60 (secs) 0 (0x0000) PairModeTimeout_s (secs) (0xffff) MuteRemindTime_s 0-60 (secs) Table A.8: PS Key USR6 Timers and Counters 5 (0x0005) LionkLossNumRetries_s 0-60 (secs) 5 (0x0005) CheckForAudioTransferDelay_s 0-30 (secs) 1 (0x0001) AutoSwitchOffTime_s: The Time in seconds after which the headset will switch off if not connected. if==0 then headset remains on indefinitely. AutoPowerOnTimeout_s: The value in seconds that the headset waits after powering up to see if a power on event occurs. After this time, the headset will return to the off state. NetworkServiceIndicatorRepeatTime_s: The time in seconds after which the network service indication will be replayed if there is no network present in the connected AG. DisablePowerOffAfterPowerOnTime_s: The time after Power On for which the Power Off event has no effect. This is used for example, if the UI specifies that a long press on Power On enters pairing mode but a long press at any other time (including in the connectable state) should Power Off the headset. PairModeTimeout_s: The time in seconds that the headset remains in the connectable / discoverable state (pairing mode). Setting this to 0 will result in the headset entering and immediately exiting discoverable mode, with the result that the device cannot be discovered. If the headset is to always be discoverable whilst not connected, then the feature bit Automatic Pairing Mode Enable (see PS Key USER15 on page 22) should be used in conjunction with this timeout. MuteRemindTime_s: The time between mute reminder updates. This is used for LED and Tone reminders to indicate that the headset is muted. LinkLossNumRetries: Specifies the Number of retries to be made if an abnormal disconnect (link loss) occurs. Each retry is initiated after a 10 second delay. CheckForAudioTransferDelay: Timeout after an SLC establishment before the V4 software attempts to create a SCO link to the AG device. Page 19 of 58

20 A.9 Radio Configuration PS Key USR13 determines the radio Inquiry and Page scan characteristics: Label Inquiry Scan Interval (slots) Inquiry Scan Window (slots) Inquiry Scan Interval (slots) Inquiry Scan Window (slots) Type uint16 uint16 uint16 uint16 Range (0x0012 0x1000) Default Value (0x0012 0x1000) (0x0012 0x1000) (0x0012 0x1000) 2048 (0x0800) 18 (0x0012) 2048 (0x0800) 18 (0x0012) Table A.9: PS Key USR13 Radio Configuration Bit Fields Note: Default values quoted are for Headset v4 four button configuration. BlueVOX Configurator does not provide an interface to this PS Key. The default values have been selected to give the best performance characteristics and it is not recommended that these are changed in most circumstances. Page 20 of 58

21 A.10 NiMH Charger Configuration PS Key USR14 holds the required parameter values used to configure the quick charge cycle for a NiMH battery. Note: NiMH batteries are either trickle or quick charged. The parameters configured in this PS Key are associated with the quick charge cycle and are very important in order to protect the lifetime of the battery. Label QC Min Voltage (mv) QC Max Voltage (mv) Type uint16 uint16 QC dv Voltage (mv) uint16 (D15-8) QC dv Inhibit Time (D7-0) QC Max Battery (Temp o C) uint16 (D15-8) QC Min Battery (Temp o C) (D7-0) Range Default Value QC Td ( o C) (D7-0) 1800 (0x0708) QC Time (mins) uint16 (D15-8) 3300 (0x0ce4) Thermister Enable PIO (D7-0) 7 (0x07) Thermister m 15 (0x0f) to to (0x00) 120 (0x78) 4 (0x04) 40 (0x28) 00 (0x00) Thermister c VDet m VDet c QC Temp Update Period (mins) uint16 (D15-8) 4 (0x04) int16 int16 int16 int16 int16-48 (0xffd0) 68 (0x0044) -100 to (0x0000) to 1000 Table A.10: PS Key USR14 NiMH Charger Configuration Bit Fields Note: Default values quoted are for Headset v4 four-button configuration. The default PS Key s hex value is: ce4 070f ffd (0x0000) dt Threshold ( o C) (0x0001) Page 21 of 58

22 A.11 Feature Configuration PS Key USR15 holds three words used to configure features as described in this section. Word 1 Word 2 Word 3 General Features Reconnection Policy Extended Features Word 1 General Features Bit D15 D14 D13 D12 D11 D10 D9 D8 Feature Mic Bias uses LDO Codec Gain Scale Mute Control Speaker Gain Play Tones at Fixed Volume Reboot after Reset Remain Discoverable at all times Disable Power Off after Power On Default D7 D6 D5 D4 D3 D2 D1 D0 Use User defined Codec Gain Values Power On uses Internal LDO Power On uses Internal SMPS Mute Local Volume Action Mute Override NiMH Battery Charger Enable LiON Battery Charger Enable Description of Bit Fields Mic Bias Uses LDO: Table A.11: PS Key USR15 Feature Configuration Bit Fields Bit = 1: The internal LDO is used for the mic bias. Bit = 0: The PIO defined in the PS Key CODEC_PIO is used for the mic bias. Auto Answer on Connect Automatic Pairing Mode Enable If this is not set correctly for a particular hardware design microphone audiopath may not work correctly. - the Internal LDO can also be enabled on Power On via the Power On Internal LDO feature bit (D6). The use of the LDO for the Mic Bias is not generally recommended as it can reduce audio quality. Codec Gain Scale: Bit = 1: The Profile Volumes are scaled across the full range of Speaker Gain Values (0-23). This provides the full audible range for the headset. Bit = 0: The Profile Volumes use the Speaker Gain range This provides equal steps of around 2.5/3dB per Profile Volume Setting. Mute Controls Speaker Gain: Bit = 1: Mute will mute the Speaker and the Microphone of the headset. Bit = 0: Only the Microphone will be muted. Page 22 of 58

23 Play Tones at Fixed Volume: Bit = 1: Tones are played at a nominal fixed volume regardless of the current Profile Volume level. Note: By default the fixed volume at which the tones will be played if this bit is set is HFP Volume Level 1. Bit = 0: Tones are played at the current Profile Volume level. Reboot after Reset: Bit = 1: The headset powers off after a Reset has been issued. Bit = 0: The headset does not power off after a Reset has been issued. Note: Reset clears the Default and Last user together with the list of Paired devices. Auto Answer on Connect: This allows the headset to send an answer (ATA) AT command if an incoming call is detected on connection. Bit = 1: Headset sends answer (ATA) AT command. Bit = 0: Headset does not respond to an incoming call detected on connection. Note: Some AGs will attempt to auto answer the call on connection. Use User defined Codec Gain Values: Bit = 1: The application uses the CODEC Gain settings set in PS Key USR16 (Speaker Gain Mapping, see Appendix A.12). Bit = 0: Gains are scaled according to the Codec Gain Scale feature bit (D14). Disable Power Off after Power On: Bit = 1: Disables Power Off for 20 seconds after Power On. Note: This is used for example, if the UI specifies that a long press on Power On enters pairing mode but a long press at any other time (including in the connectable state) should Power Off the headset. Bit = 0: Power Off is not disabled during Power On. Mute Override: If the headset is muted (via the EventMuteToggle or EventMuteOn), then this bit controls the action to take when an EventVolumeUp/EventVolumeDown or an AG volume indication message occurs: Bit = 1: Volume events cause the headset to unmute and set the volume to the new level. Bit = 0: Volume events do not unmute the headset and the local headset volume value is updated according to the Mute Local Volume Action feature bit (D4). Mute Local Volume Action: This controls whether or not an EventVolumeUp, EventVolumeDown or an AG volume indication message updates the headset s local volume variable (when the headset is muted): Bit = 1: The headset updates the volume variable and the next time the headset is unmuted, the new volume will take effect. Bit = 0: The headset ignores any volume requests until it is unmuted. Power On Internal LDO: This controls whether the Power On event latches on the internal Linear Regulator (LDO: Low Drop Out): Bit = 1: Latched on Bit = 0: Not Latched on Page 23 of 58

24 Power On Internal SMPS: This controls whether the Power On event latches on the internal Switch Mode Power Supply (SMPS): Bit = 1: Latched on Bit = 0: Not Latched on Word two - Reconnection Policy Bit D15 D14 D13 D12 D11:D8 D7:D4 D3:D0 Feature Default different to Last AG Paired Device List is Shuffled on Connection Auto- Reconnect Power On Auto- Reconnect Link Loss Reconnect Action on Connect Reconnect Action on Call Transfer Reconnect Action on Power On Range 0-1 n/a (1) 0-6 (1) 0-6 (1) BlueVOX default 0x0 0x0 0x0 0x1 0x01 0x01 0x01 (1) See Reconnect Action for descriptions of options Table A.12: PS Key USR15 Word two - Reconnection Policy Bit Fields Note: Default values quoted are for Headset v4 four-button configuration. Description of Bit Fields Default Different to Last AG: This bit field defines how the application interprets the Default and Last connected AGs: Bit = 1: Default is the first ever paired AG and the Last is the last connected AG (BUT ONLY if the last was different to the default) Bit = 0: Default is the first ever paired AG and the Last is the last connected AG (i.e any device - can be the same as the default). Paired Device is Shuffled on Connections: This controls the order in which the reconnect action - list attempts to connect to the 8 devices in the paired device list 0 - paired device list will contain the order of pairing 1 - paired device list will contain the order of connecting. Bit = 1: Paired device list will contain the order of connecting. Bit = 0: Paired device list will contain the order of pairing. Page 24 of 58

25 Reconnect Action There are eight Reconnection Action options. The option required can be set separately for Power On and following Disconnect and Call Transfer events: Note: The Call Transfer Reconnect Action is evoked when the headset is used to transfer a call to the AG then back to the headset. Reconnect entry Action 0 (0x00) Attempt to Reconnect to the last connected AG 1 (0x01) Attempt to Reconnect to LAST connected AG 2 (0x02) Attempt to Reconnect to DEFAULT AG 3 (0x03) Attempt to Reconnect to LAST AG then DEFAULT AG 4 (0x04) Attempt to Reconnect to DEFAULT AG then LAST AG Attempt to Swap AG i.e if was DEFAULT then now 5 (0x05) LAST AG etc Attempt to Swap then swap again AG i.e if was 6 (0x06) DEFAULT then now LAST then DEFAULT AG etc Attempt to connect to all 8 devices in the paired device 7 (0x07) list. If we have just been cleanly disconnected then the list does not include the device just dropped Where: last = Last connected device ( i.e The LAST or DEFAULT or none if freshly powered On). LAST = This is defined in Default Different to Last, if: Bit =1: Then this is the last connected device that is not the DEFAULT Bit =0: Then this is the last connected device (can be the DEFAULT device) DEFAULT = First device ever connected Table A.13: PS Key USR15 Word two - Reconnection Action Auto Reconnect Power on: Defines the Auto Reconnect action when the headset receives a Power On event: Auto Reconnect Link Loss: Defines the Auto Reconnect action when the headset loses the SLC connection to an AG with a resulting Link Loss Error code: Reconnect Action on Connect: Defines the AG that the device will try to connect to when an Establish SLC event is received. i.e. when a user generated event requiring a connection is received by an unconnected headset e.g. Connect, Voice dial or Last Number Redial events. Reconnect Action on Call Transfer: Defines the AG that the device will try to connect to when a call that has been transferred to an AG is transferred back to the headset (using the headset). Note: i.e. the Call Transfer Reconnect Action is evoked when the headset is used to transfer a call to the AG then back to the headset. This only applies to Ags that disconnect the headset when it transfers a call. Reconnect Action on Power On: Defines the AG that the device will try to connect to at next Power On event. If The Auto Reconnect Power On bit field is set to 1. Page 25 of 58

26 Word three Extended Features Bit D15 to D12 D11 D10 D9 Feature DiscoIfPDLLessThan:4 Reserved Reserved ListConnectNextButOne Default D8 D7 D6 D5 D4 EncryptOnSLCEstablishment VGSDoesNotSetMicGain Play Volume Tone on Remote Indication Secure Pairing D3 D2 D1 D0 Use Raw Mic Gains Use Raw Speaker Gains Queue Tone Events Queue LED Events Use Last Paired user as well as Last Connected user Description of Bit Fields Table A.14: PS Key USR15 Word three Extended Features Bit Fields DiscoIfPDLLessThan: This forces the headset to Enter Discoverable mode (pairing) if the paired device list is less than the entry here. i.e. an entry of 2 would mean that if the headset has previously paired with either 0 or 1 devices, then the headset will enter discoverable mode. Bit = 0: Feature disabled. Bit = 1-7: Feature enabled. ListConnectNextButOne: On a disconnect when using the list reconnection policy: Bit = 0: Attempt connect to the first item in the list and then all others. Bit = 1: Attempt connect to the second item in the list and then all others EncryptOnSLCEstablishment: This forces Encryption on SLC establishment. Some Nokia S40 phones now do not force encryption on the SLC. Setting this bit ensures that encryption is used. Bit = 0: Encryption not enforced. Bit = 1: Ensures that encryption is used. VGSDoesNotSetMicGain: This configures how the local microphone gain level behaves. Bit = 0: The mic level will be updated according to policy in Word 1 & PSKEY_USR_16, see A.12Speaker Gain Mapping. Bit = 1: The local microphone gain level will not be set on a VGS command from the AG. Page 26 of 58

27 Play volume tone on remote indication: This forces the headset to play a tone when the volume is adjusted from the remote end if tones are configured to be played. Bit = 0: Feature disabled. Bit = 1: Feature enabled. Secure Pairing: This bit enables secure pairing mode. If set, then the headset will only accept pin code requests when in pairing mode (connectable/discoverable state). This prevents a remote user from pairing with the headset without the headset being specifically placed into paring mode. This is over-ridden if the headset initiates the connection. ie - if a headset attempts to connect to a remote AG without the correct link key (or has the bdaddr but not the link key) then the headset will accept a pin code request. Bit = 0: Feature disabled. Bit = 1: Feature enabled. Use Raw Mic Gains: This allows the user gain defined in PS Key USR16 to be split into a separate analogue and digital gain for control of the mic gain The Set Raw API is used to control the mic gain. Bit = 0: Feature disabled. Bit = 1: Feature enabled. Use Raw Speaker Gains: This allows the user gain defined in PS Key USR16 to be split into a separate analogue and digital gain for control of the speaker gain. This must be used in conjunction with Use User defined Codec Gain Values. Bit = 0: Feature disabled. Bit = 1: Feature enabled. Use Last Paired User as well as Last Connected User: This will cause the HS to store the pairing information for the last paired user as well as the last connected user. Bit = 0: The HS will only attempt to the last connected user and ignore any users that have been paired but not connected. Bit = 1: and an AG is paired to the HS but not connected, then the HS will attempt to reconnect to the last paired device on power on. Queue Tone Events: This allows tones to be queued in the headset: Bit = 1: Queued tones will be played in sequence. Note: Up to 4 tones can be held in the queue. Bit = 0: Any request to play a tone whilst another is playing, will be ignored. Queue LED Events: This allows LED indicator patterns (up to four) to be queued in the headset. Bit = 1: Queued LED patterns will be displayed in sequence. Note: Up to 4 LED patterns can be held in the queue. Bit = 0: Any request to display an LED sequence whilst is active will be ignored. Use Last Paired User as well as Last Connected User: This causes the headset to store the pairing information for the last paired user as well as the last connected user. bit = 1: If an AG is paired to the headset but has not been previously connected, then the headset will use this information to attempt to connect to the last paired device on Power On if bit D13 (Auto- Reconnect Power On) in word two is set. Note: If this bit is not set, pairing information for an AG that has been paired but not connected will be discarded when the headset is powered off. bit = 0: The headset will attempt to connect to the last connected AG and will ignore any AGs that have been paired (but not connected) since the last connection. Page 27 of 58

28 A.12 Audio Gain Mapping PS Key USR16 holds values that configure the Speaker/Mic Gain behaviour of the application. PS Key USR16 supports both Predefined Gains and Raw Gains. Two feature bits govern which method is used to configure PS Key USER16. Check the Use Raw Speaker Gains and Use Raw Mic Gains options in the Configurator s Features tab to configure Raw Gains, leave these options unchecked to configure the audio gain using Predined Gains. A.11.1 PS Key USER16 configured to use Predefined Gains Label Type Range Increase Action Decrease Action Mic Gain Level uint16 (D15-12) (D11-8) (D7-4) (D3-0) 0-15 (0x0-0xf) 0-15 (0x0-0xf) 0-15 (0x0-0xf) Tones Speaker Gain Mic Gain 0-15 (0x0-0xf) uint16 (D15-8) (D7-0) 0-22 (0x00-0x16) Table A.15: PS Key USR16 Predefined Audio Gain Mapping Bit Fields 0-22 (0x00-0x16) The PS Key contains a total of 128 Hex numbers representing each of the 16 (0-15) Profile Volume settings in the AG profile. Each volume button press adjusts the Profile Volume setting by one level. Example A single volume press configuration entry for Profile Volume Level 7 might be 0x a and would equate to: Label Configuration Value Action Increase action 0x8 Go to Profile Volume level 8 Decrease action 0x6 Go to Profile Volume level 6 Mic Gain level 0x7 Set Mic Gain Level to 7 for this Profile Volume level Tones 0x1 Play Middle 0, see Appendix C Speaker Gain 0x09 Set the CODEC Gain for the Speaker to 9 (-18dBr) Mic Gain 0x0a Set the CODEC Gain for Mic to 10 (-15dBr) Table A.16: Volume Press Configuration Example Entries for each of the other 16 (0-15) Volume Gain settings appear in sequence in the PS Key. Page 28 of 58

29 CODEC Gain Settings Speaker and Mic Gain values support the range 0 to 22 (0x00 to 0x16) these values equate to the gain settings: CODEC (Speaker/Mic) Gain (0-22) Digital Gain Analogue Gain GAIN (dbr) Value to set Internal Internal Gain achieved at Speaker/Mic Table A.17: CODEC Predefined Gain Settings Note: For simplicity the BlueVOX Configurator allows engineers to set the Speaker or Microphone Gains from a drop down list of Gain (dbr) values. Page 29 of 58

30 Typical Values Table A.17 shows a typical set of values for the gain settings of a headset application: Profile Volume Increase Action Decrease Action Mic Gain Level Tone Speaker Codec Gain Mic Codec Gain x04 0x x06 0x x06 0x x06 0x x06 0x x07 0x x08 0x x09 0x x0a 0x12 9 a x0b 0x12 a b 9 a 4 0x0c 0x12 b f a b 4 0x0d 0x12 c f b c 4 0x0f 0x12 d f b d 4 0x0f 0x12 e f b e 4 0x0f 0x12 f f b f a 0x0f 0x13 This equates to a PS Key hex value of: Table A.18: CODEC Gain Typical Settings a12 a894 0b12 b9a4 0c12 fab4 0d12 fbc4 0f12 fbd4 0f12 fbe4 0f12 fbfa 0f13 Note: This is used as the default value for PS Key USR16 in the BlueCore4-Headset. A.11.2 PS Key USER16 configured to use Raw Gains When the Use Raw Gain feature bit set the user must provide values of analogue and digital gain values to create the attenuation level required for the application. Label Type Increase Action Decrease Action Mic Gain Level (HFP) Tones uint16 (D15-12) (D11-8) (D7-4) (D3-0) Raw Analogue Speaker Gain Raw Digital Speaker Gain Raw Analogue Mic Gain Raw Digital Mic Gain uint16 (D15-12) (D11-8) (D7-4) (D3-0) Range 0-15 (0x0-0xf) 0-15 (0x0-0xf) 0-15 (0x0-0xf) 0-15 (0x0-0xf) 0-7 (0x0-0x7) 0-15 (0x0-0xf) 0-7 (0x0-0x7) 0-15 (0x0-0xf) Table A.19: PS Key USR16 Raw Audio Gain Mapping Bit Fields Page 30 of 58

31 The separate digital and analogue values each provide an attenuation level in dbr, the values of both of these fields are added together to produce an overall gain for speaker and mic, there are separate entries for speaker and mic gains. The digital gain can be set to one of 15 values. The values provide the attenuation values shown in Table A.20: Digital Gain Gain (dbr) Internal Gain achieved at speaker/mic Table A.20: Raw Digital Gain Values The Raw analogue gain component can have 1 of 8 values: Analogue Gain (dbr) Internal Gain achieved at speaker/mic Table A.21: Raw Analogue Gain Values Using a combination of analogue and digital gains from the raw gain tables it is possible to set smaller step sizes than those available when using the predefined gain tables. However, the range of available step sizes available is still limited and it may still be impossible to achieve the exact gain required, in some cases a near to value is the best that can be achieved. Page 31 of 58

32 For example to achieve an attenuation level of -11dB, two approaches would be to set the gains as shown: 1. Set Raw Analogue Gain to 4, giving an attenuation value of -9dB Set Raw Digital Gain to 15, giving an attenuation value of -2.5dB Combining the analogue and digital gain results in an actual attenuation of -11.5dB 2. Set Raw Analogue Gain to 6, giving an attenuation value of -3dB Set Raw Digital Gain to 13, giving an attenuation value of -8.5dB Combining the analogue and digital gain results in an actual attenuation of -11.5dB An example of a typical single HFP level entry in PSkey USR16 might be: FCE1 4F4F This entry would define HFP Mic Gain Level 14 with the attenuation of -11.5dB (as in the first example configuration above), Increase action = go to level 15, Decrease action = go to level 13, headset tone = middle 0. Setting the Audio Gain using the Raw configuration, whilst providing more precise control, is more time intensive as engineers must consider the possible combinations that can be used to achieve the required Gain level. Engineers should be aware that the use of positive digital gain settings should be avoided as they are likely to result in audio distortion. Page 32 of 58

33 A.13 LED State Configuration Each headset state can be associated with a unique LED flashing pattern. The necessary configuration is defined in two PS Keys: USR19: specifies the number of LED flashing patterns (entries) defined in PS Key USR20. USR20: holds the attributes of 1 to n entries defined as follows. Word 1 Word 2 Label Headset State LED On time (x10ms) LED off tim (x10ms)e Type uint16 (D15-8) (D7-0) uint16 (D15-8) (D7-0) Range/Description See Appendix Appendix B ms (in 10ms steps) Word 3 Word ms (in 10ms steps) LED repeat time (x50ms) ms (in 50ms steps) LED Dim Time Time out Number of flashes LED_A LED_B Colour uint16 (D15-8) (D7-0) uint16 (D15-12) (D11-8) (D7-4) (D3-0) 0-255ms ms 0-15 see below see below see below Description of Bit Fields Table A.22: PS Key USR20 - LED State Configuration Bit Fields Headset State: System state associated with the LED pattern being defined, see Appendix D On time, Off time, Number of flashes and Repeat time values: Figure 1: LED Pattern Page 33 of 58

34 Dimming LEDs: Dimming / Ramping LEDs are available if running on BlueCore4 Audio ROM and BlueCore4 Headset-based hardware. Dimming LEDs can be enabled by entering a value in the LED Dimming field. This value is the time between ramp steps to use. There are 16 ramping steps used to Dim on or off an LED. It is important to ensure that the (Dim time * 16) is less than the on time / off time for the ramp to complete. E.g. For a 1 second on 1 second off pattern, then a good Dim time to use would be 800ms / 16 = 50 = 0x32. Time out: This field specifies the number of times the sequence, specified by the entry, will repeat (unless superseded by another event) before it times out. When set to 0 the sequence will not time out. LED_A: This field is a bitmask that specifies the PIO that will be referred to in the PS Key attributes as LED_A. Bit D15 D14 D13 D12 D11 D10 D9 Mask value LED_1 LED_0 Tricol_a LEDs * Tricol_b LEDs * Tricol_c LEDs * PIO_10 D8 D7 D6 D5 D4 D3 D2 D1 D0 PIO_9 PIO_8 PIO_7 PIO_6 PIO_5 PIO_4 PIO_3 PIO_2 PIO_1 PIO_0 Table A.23: PS Key USR20 LED_A Bitmask LED_B: This field is a bitmask that specifies the PIO that will be referred to in the PS Key attributes as LED_B. Bit D15 D14 D13 D12 D11 D10 D9 Mask value LED_1 LED_0 Tricol_a LEDs * Tricol_b LEDs * Tricol_c LEDs * PIO_10 D8 D7 D6 D5 D4 D3 D2 D1 D0 PIO_9 PIO_8 PIO_7 PIO_6 PIO_5 PIO_4 PIO_3 PIO_2 PIO_1 PIO_0 Table A.24: PS Key USR20 LED_B Bitmask Colour: This field defines the LED(s) that the sequence will display when a filter is not applied. The options for this field are defined as: bit value = 0000: Reserved bit value = 0001: LED_A bit value = 0010: LED_B bit value = 0011: Alternate bit value = 0100: LED_BOTH Page 34 of 58