Académique Documents
Professionnel Documents
Culture Documents
BlueVOX2 Configurator
User Guide
September 2006
CSR
Cambridge Science Park
Milton Road
Cambridge CB4 0WH
United Kingdom
Contents
1 Introduction .................................................................................................................................................... 3
1.1 General.................................................................................................................................................... 3
2 Description of BlueVOX Configurator Workspace ...................................................................................... 4
2.1 Functionality ............................................................................................................................................ 5
2.1.1 File Menu ..................................................................................................................................... 5
2.1.2 Output Menu ................................................................................................................................ 5
2.1.3 Properties Menu........................................................................................................................... 6
1 Introduction
BlueVOX is the generic name for CSRs mono headset solutions. BlueVOX provides a fast-track Bluetooth
headset solution allowing manufacturers to rapidly develop their own unique mono headset designs.
BlueVOX2 Configurator is a user-friendly tool developed to configure the Headset V4 and Headset V4 Refresh
mono headset software to suit the manufactures Human Machine Interface (HMI) design.
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.
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.
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.
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.
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.
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.
Buttons displayed on the left of the BlueVOX Configurator application window also provide Write PSR and Write
Device functionality.
Transport: Allows the transport protocol used to communicate with a connected BlueCore device to be
defined.
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.
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.
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 softwares
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.
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: CSRs BlueCore4-Audio ROM is compatible with EEPROM devices from many different manufacturers and with
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 www.csrsupport.com.
For I2C EEPROM devices manufactured by ST, Rohm and Microchip, the appropriate Log2Bytes AddrMask
parameters depend on the memory capacity shown in Table 5.1.
16 Rohm BR24E16
ST24E16 11 0
ST
ST25E16
24AA515
512 Microchip 24LC515 16 4
24FC515
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
1 7 0
2 8 0
4 9 1
8 10 3
16 11 7
32 12 0
64 13 0
128 14 0
256 15 0
512 16 0
1024 17 1
Table 5.2: e2write Parameters for EEPROMs from All Other Manufacturers
1. Download the BlueSuite Development Tools from the Headset section of www.csrsupport.com. 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
e2write -DEVICE 11 0
The EEPROM is now initialised and is suitable for use as the Persistent Store.
Note: The PSTool utility is shipped as part of BlueLab or can be downloaded from the CSR support website.
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 www.csrsupport.com.
6 Document References
Document Reference
Minimum Shutdown
Label Divider Ratio Gas Gauge Level 1
Threshold Threshold
Default Value 405 (0x0195) 165 (0x00a5) 150 (0x0096) 170 (0x00aa)
Gas Gauge Level 2 Gas Gauge Level 3 Unused Monitoring period Reminder Time
Notes:
(1)
The Battery monitoring will occur every Monitoring Period time.
(2)
If the battery voltage is below Shutdown threshold then the headset will perform a clean disconnect and will power
off.
(3)
If the battery voltage is above Shutdown threshold and below Minimum threshold then eventBatteryLow will be
reported.
(4)
If the battery voltage is above Minimum threshold and below Gas Gauge Level 1 then the headset will report
eventbatteryOK and EventGasGauge0
(5)
If the battery voltage is above Gas Gauge Level 1 and below Gas Gauge Level 2 then the headset will report
eventbatteryOK and EventGasGauge1
(6)
If the battery voltage is above Gas Gauge Level 2 and below Gas Gauge Level 3 then the headset will report
eventbatteryOK and EventGasGauge2
(7)
If the battery voltage is above Gas Gauge Level 3 then the headset will report eventbatteryOK and
EventGasGauge3
Default
500 (0x01f4) 1000 (0x03e8) 35000 (0x0dac) 800 (0x0320) 5000 (0x1388)
Value
Note: Default values quoted are for Headset v4 four button configuration.
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.
Range 0x6001 - 0x603f Set bit pattern for required button press sequence
Default
N/a N/a N/a N/a N/a N/a N/a
Value
Example
To configure the event EventEnterDUTmode as a result of 6 presses of PIO[0] the key would hold the hex
value:
6015 0001 0001 0001 0001 0001 0001 0000 0000 0000 0000 0000 0000 0000
Note: Normal system events should be configured using PS Keys USR23 and USR24. See A.15 Event
Configuration.
A 16-bit unsigned integer bitmask is used to report support for the following features:
Example
To indicate support for three way calling and remote voice control the bitmask would be set as:
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)
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
Table A.6: PS Key USR4 HFP 1.5 Feature Configuration Bit Fields
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.
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
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.
To enable HFP 1.5 if USR5 is set manually, the following PS Key must also be set manually:
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
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
NetworkServiceIndicatorRepeatTime_s
DisablePowerOffAfterPowerOnTime_s
CheckForAudioTransferDelay_s
PairModeTimeout_s
MuteRemindTime_s
Label
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.
Inquiry Scan Interval Inquiry Scan Inquiry Scan Interval Inquiry Scan
Label
(slots) Window (slots) (slots) Window (slots)
Range 18-4096
18-4096 18-4096 18-4096
(0x0012
(0x0012 0x1000) (0x0012 0x1000) (0x0012 0x1000)
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.
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.
QC Min QC Temp
QC Min QC Max QC dV QC dV QC Max
Battery Update
Label Voltage Voltage Voltage Inhibit Battery
o (Temp Period
(mV) (mV) (mV) Time (Temp C) o
C) (mins)
dT
QC Td QC Time Thermister Thermister
Thermister c VDet m VDet c Threshold
(oC) (mins) Enable PIO m o
( C)
uint16
int16 int16 int16 int16 int16
(D7-0) (D15-8) (D7-0)
0 120 4 -48 68 0 0 1
(0x00) (0x78) (0x04) (0xffd0) (0x0044) (0x0000) (0x0000) (0x0001)
0708 0ce4 070f 2800 0400 7804 ffd0 0044 0000 0000 0001
Default 0 0 0 1 1 0 0 0
D7 D6 D5 D4 D3 D2 D1 D0
Use User
Power On Power On NiMH LiON Automatic
defined Mute Local
uses uses Mute Battery Battery Pairing
Codec Volume
Internal Internal Override Charger Charger Mode
Gain Action
LDO SMPS Enable Enable Enable
Values
1 0 1 0 0 0 1 0
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.
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 4-19. This provides equal steps of around
2.5/3dB per Profile Volume Setting.
Bit = 1: Mute will mute the Speaker and the Microphone of the headset.
Bit = 0: Only the Microphone will be muted.
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 = 1: The headset powers 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.
Note: Some AGs will attempt to auto answer the call on connection.
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).
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 headsets 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
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
Paired
BlueVOX
0x0 0x0 0x0 0x1 0x01 0x01 0x01
default
(1)
See Reconnect Action for descriptions of options
Table A.12: PS Key USR15 Word two - Reconnection Policy 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.
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.
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.
Default 0000 0 0 0
Play Volume
Tone on Secure Use Raw Mic
EncryptOnSLCEstablishment VGSDoesNotSetMicGain
Remote Pairing Gains
Indication
1 0 0 0 0
D3 D2 D1 D0
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: 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.
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.
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.
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
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.
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.
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.
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 = 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.
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 Configurators Features tab to configure Raw Gains, leave these options
unchecked to configure the audio gain using Predined Gains.
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 0x8671 090a and would equate
to:
Entries for each of the other 16 (0-15) Volume Gain settings appear in sequence in the PS Key.
Speaker and Mic Gain values support the range 0 to 22 (0x00 to 0x16) these values equate to the gain
settings:
CODEC (Speaker/Mic)
Digital Gain Analogue Gain GAIN (dBr)
Gain (0-22)
Note: For simplicity the BlueVOX Configurator allows engineers to set the Speaker or Microphone Gains from a drop
down list of Gain (dBr) values.
Typical Values
Table A.17 shows a typical set of values for the gain settings of a headset application:
0 4 0 0 1 0x04 0x11
1 4 0 1 4 0x06 0x11
2 4 0 2 4 0x06 0x11
4001 0411 4014 0611 4024 0611 4034 0611 5044 0611 6454 0711 7564 0811
8674 0912 9784 0a12 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.
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.
uint16 uint16
Type
(D15-12) (D11-8) (D7-4) (D3-0) (D15-12) (D11-8) (D7-4) (D3-0)
0 - 15 0 - 15 0 - 15 0 - 15 0-7 0 - 15 0-7 0 - 15
Range (0x0 - (0x0 - (0x0 - (0x0 - (0x0 - (0x0 - (0x0 - (0x0 -
0xf) 0xf) 0xf) 0xf) 0x7) 0xf) 0x7) 0xf)
Table A.19: PS Key USR16 Raw Audio Gain Mapping Bit Fields
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:
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.
For example to achieve an attenuation level of -11dB, two approaches would be to set the gains as shown:
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
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.
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
Range/Description See Appendix 0-2550ms (in 10ms 0-2550ms (in 10ms 0-10000ms (in
Appendix B steps) steps) 50ms steps)
Word 3 Word 4
LED Dim Time Time out Number of flashes LED_A LED_B Colour
Headset State: System state associated with the LED pattern being defined, see Appendix D
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.
D8 D7 D6 D5 D4 D3 D2 D1 D0
LED_B: This field is a bitmask that specifies the PIO that will be referred to in the PS Key attributes as LED_B.
D8 D7 D6 D5 D4 D3 D2 D1 D0
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:
Example
A typical example of an LED State configuration is the default LED indication for the Connectable state in
BlueVOX2 headsets:
Label Headset State LED On time LED off time LED repeat time
Number of
LED Dim Time Time out LED_A LED_B Colour
flashes
This results in LED_1 flashing twice for 100ms every 2 seconds while the device is connectable.
USR21: specifies the number of LED flashing patterns (entries) defined in PS Key USR22.
USR22: holds the attributes of 1 to n LED flashing patterns.
Headset System LED On time LED off time LED repeat time
Label
Event (x10ms) (x10ms) (x50ms)
Range/Description See Appendix 0-2550ms (in 10ms 0-2550ms (in 10ms 0-10000ms (in
Appendix B steps) steps) 50ms steps)
Word 3 Word 4
Headset System Event: System event associated with the LED pattern being defined, see Appendix B
Note: This is specified as an offset of 0x6000 i.e. to specify the Power On Event (0x6001) the value of this field
would be 0x01.
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(s) to which LED are connected.
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:
Example
A typical example of an LED event configuration is the default LED indication for the Power On event in
BlueCore4-headsets:
Label Headset Event LED On time LED off time LED repeat time
This results in LED_1 flashing once for 1000ms (1 second) when the Power On event is generated.
Non-repeating patterns
To configure a PIO as an output pin for the duration of an event
Non-repeating Patterns:
A PIO can be configured as an output pin, set and unset on individual events.
As with normal Event Configuration the LED_A, LED_B and Colour fields can be used to configure the ON and
OFF conditions to influence one or two PIOs.
For example to set two pins PIO[11] and PIO[12] to high when an EventChargerConnected event is
generated, the hex value entered would be:
Headset System
Label LED On time LED off time LED repeat time
Event
Hex Value 22 ff 00 00
0x00 00 b c 0100
use both LED_A
zero zero PIO[11] PIO[12]
and LED_B
In addition, the software allows filters to be applied to individual LED patterns to change them in response to
some event or change in state. For example, to change the colour and/or frequency of a pattern being displayed
when the battery is low.
When implementing a filter it is normally necessary to create two filters, one to enable the change when the
trigger event or state change occurs and one to disable the change when trigger condition ceases.
Headset Speed
Label Speed Active Unused Colour
Event Action
Follower
Filter to Override Follower
LED to Use Unused LED Delay Unused
cancel LED Active LED Active
(x50ms)
uint16
(D7-4) (D3-0) (D15) (D14-13) (D12) (D11-8) (D7-0)
Headset event: System event associated with the LED filter being defined, see Appendix B
Note: This is specified as an offset of 0x6000 i.e. to specify the Power On Event (0x6001) the value of this field
would be 0x01.
Note: To leave the frequency of the original pattern unchanged this bit field should be set to 0.
Bit = 1: Enabled.
Bit = 0: Disabled.
Speed Action: This field specifies the action to apply to the frequency:
Bit value = 01: SPEED_MULTIPLY, multiply the frequency by the value specified in the Speed field.
Bit value = 00: SPEED_DIVIDE, divide the frequency by the value specified in the Speed field.
Filter to cancel: If the filter is set to not active (i.e. is used to cancel another defined filter when an event is
LED To Use: This field is used to specify an LED, which will be used for either the Override or LED Follower
behaviour, if they are activated.
Override LED Active: This field is set to activate or deactivate the Override LED field. When activated the LED
specified in the Override LED field will be turned ON during the OFF period of the original pattern.
bit = 1: Activate
bit = 0: Deactivate
LED Follower Active: When this bit is set the LED specified in the Override LED field repeats the original pattern
with a time offset as specified in the LED Follower delay field.
LED Follower delay (x50ms): The value in this field defines the time offset in milliseconds, between the original
pattern flashes and follower pattern flashes.
Note: The software multiplies the value entered by 50 milliseconds before it is applied.
Example
To configure filters to change all indications from Blue to Red on the BlueCore4-Headset development board
when the low battery event is received the PS Key hex values would be:
Note: All State and Event Indications that this filter is to affect need LED_A (blue) and LED_B (red) bit
fields set in PS Key USR20 (LED State Configuration) and USR22 (LED Event Configuration).
Headset Speed
Label Speed Active Unused Colour
Event Action
Follower
Filter to Override Override Follower
Unused LED Delay Unused
cancel LED LED Active LED Active
(x50ms)
uint16
(D7-4) (D3-0) (D15) (D14-13) (D12) (D11-8) (D7-0)
0000 0000 0x0 00 0 0000 00000000
0x0000
not used not used not used not used not used not used not used
Headset Speed
Label Speed Active Unused Colour
Event Action
uint16 uint16
Type
(D15-8) (D7-0) (D15) (D14) (D13-12) (D11-8)
Follower
Filter to Override Override Follower
Unused LED Delay Unused
cancel LED LED Active LED Active
(x50ms)
uint16
(D7-4) (D3-0) (D15) (D14-13) (D12) (D11-8) (D7-0)
0001 0000 0x0 00 0 0000 00000000
0x0000
st
1 filter
defined in PS not used not used not used not used not used not used
Key
The second entry to disable the battery low filter when the trickle charge event is generated, becomes:
Headset Speed
Label Speed Active Unused Colour
Event Action
uint16 uint16
Type
(D15-8) (D7-0) (D15) (D14) (D13-12) (D11-8)
Follower
Filter to Override Override Follower
Unused LED Delay Unused
cancel LED LED Active LED Active
(x50ms)
uint16
(D7-4) (D3-0) (D15) (D14-13) (D12) (D11-8) (D7-0)
0001 0000 0x0 00 0 0000 00000000
0x0000
st
1 filter
defined in PS not used not used not used not used not used not used
Key
The third entry to disable the battery low filter when the fast charge event is generated becomes:
Two PS Keys USR23 and USR24 are used to configure events. The keys are of fixed length and must be 60
words long. Each key can contain a maximum of 20 Events = 60 Words.
Note: If the key contains less than the full 20 events then the remainder of the key must be padded with zero's.
Headset State
Label System Event PIO Duration PIO Mask
Mask
Note: This is specified as an offset of 0x6000 i.e. to specify the Power On Event (0x6001) the value of this field
would be 0x01.
PIO Duration: This bit field specifies the duration attribute that must be satisfied to generate the system event.
The valid durations and their respective hex values are given below:
PIO Mask: The PIO mask is used to specify the PIO or PIOs that must be held high (pressed) to generate the
event:
For Example:
To define a simultaneous press of both PIO[0] and PIO[1] to generate the event, the value for the PIO Mask bit
field would be 0x0003.
Binary 0 0 0 0 0 0 0 0
D7 D6 D5 D4 D3 D2 D1 D0
0 0 0 0 0 0 1 1
For the system event to be generated, the headset must be in the specified state. The Headset State Mask bit
field specifies the headset state during which the system event can be generated if the other attribute conditions
are met:
D7 D6 D5 D4 D3 D2 D1 D0
To configure an Answer Call event to be generated when PIO[0] is pressed for a short duration when the headset
is in an Incoming Call state PS Key 24 would include the following hex value entry:
Example:
Therefore the PS Key hex values required to implement these tones would be:
PS Key USR25 = 0002 (indicates that there are two entries in PS Key USR26)
PS Key USR26 = ff1c 0106
A specified pin can be configured to high when one of the following events is generated:
Call Active
Incoming Ring
Outgoing Ring
Active SCO
Power On
NiMH Charger Enable
NiMH
Headset
Call Incoming Outgoing Power On Charger
Label Active Unused Unused
Active PIO Ring PIO Ring PIO PIO Enable
PIO (SCO)
PIO
uint16 uint16
Type (D11-8) (D7-4) (D3-0) (D11-8) (D7-4) (D3-0)
(D15-12) (D15-12)
Call Active: If activated, the PIO specified in this field is held high when the headset is in an ongoing call. This is
set whenever the headset is in an ongoing call. If the call is ended, either by the headset or by the AG, this PIO
will be set Low.
Incoming Ring: If activated, the PIO specified in this field is held high when the headset is in the
IncomingCallEstablish state.
Outgoing Ring: If activated, the PIO specified in this field is held high when the headset is in the
OutgoingCallEstablish state.
Headset Active SCO: If activated, the PIO specified in this field is held high when SCO is active and audio is
routed to the headset.
Power On: If activated, the PIO specified in this field is held high when the headset is in the On state.
NiMH Charger Enable: If activated, the PIO specified in this field is held high to switch on the external NiMH
battery fast charging circuit.
Example:
To configure a Power On PIO[6] and a Ringing PIO[10]. The PS Key value would be configured as follows:
NiMH
Call Incoming Outgoing Active Power
Label Charger Unused Unused
Active Ring Ring SCO On
Enable
Binary
1111 1010 1111 1111 0110 1111 1111 1111
Value
Hex value 0xf 0xa 0xf 0xf 0x6 0xf 0xf 0xf
faff 6fff
A bitmask is used to specify the PIO/LED attached to the Tricolour connection pins:
D8 D7 D6 D5 D4 D3 D2 D1 D0
PS Key USR28
Following the example configuration above specifying the LED entries in LED Filter Configuration (PS Key
USR18), LED Configuration (PS Key USR20) or LED Event Configuration (PS Key USR22) will have the
following results:
The first word of the entry defines the number of entries for the Normal and SCO power table with a role for each
Word 1
Subsequent entries define the power table for each mode. Each entry is in the form:
This example describes the default settings to describe a typical power table entry:
Word 1
decimal 1 2 1 2
Entry lp_passive 0 0 0 0 1
Hex value 0x00ff 0x0000 0x0000 0x0000 0x0000 0x0001
Entry lp_sniff 800 800 4 1 0
Hex value 0x0001 0x0320 0x0320 0x0004 0x0001 0x0000
SCO Mode power table:
Entry lp_passive 0 0 0 0 1
Hex value 0x00ff 0x0000 0x0000 0x0000 0x0000 0x0001
Entry lp_sniff 160 160 4 1 0
Hex value 0x0001 0x00a0 0x00a0 0x0004 0x0001 0x0000
Thus the hexadecimal entry for the PS key would be:
1212
00ff 0000 0000 0000 0000 0001 0001 0320 0320 0004 0001 0000
00ff 0000 0000 0000 0000 0001 0001 00a0 00a0 0004 0001 0000
Word 1defines the device as slave in both modes and indicates that there are two power table entries for each
mode.
Note: In the majority of situations, System Events are referenced in PS Keys as an offset of their base 0x6000.
i.e. EventPowerOn (0x6001) is identified using 0x01. However, in some cases the full Event number is
required.
No tone 0x00
Middle 0 0x01 G5 300ms
Short 1 0x02 C6 100ms
Short 2 0x03 E6 100ms
Document History
Revision Date History
BlueVOX2 Configurator
User Guide
CS-110372-UGP1
September 2006
Unless otherwise stated, words and logos marked with or are trademarks registered or owned by CSR plc or
its affiliates. Bluetooth and the Bluetooth logos are trademarks owned by Bluetooth SIG, Inc. and licensed to
CSR. Other products, services and names used in this document may have been trademarked by their respective
owners.
The publication of this information does not imply that any license is granted under any patent or other rights
owned by CSR plc.
CSR reserves the right to make technical changes to its products as part of its development programme.
While every care has been taken to ensure the accuracy of the contents of this document, CSR cannot accept
responsibility for any errors.
CSRs products are not authorised for use in life-support or safety-critical applications.