Baracoda IDBlue, Supplementary Manual

Page 1: ...Data Capture for Workforce in Motion IDBlue Communication Protocol Baracoda TM December 2008...

Page 2: ...TED MODE 10 TAG VERIFY 10 STORE TIMESTAMP TAG ID BLOCK 0 DATA 10 CATHEXISWEB 10 CONNECTED MODE 11 NORMAL 11 REACTIVE 11 READ BLOCK N 11 WRITE BLOCK N 11 READ BLOCKS 11 DEVICE CONFIGURATION 12 CONTINUO...

Page 3: ...IDBlue Communication Protocol v2 4 1 3 Data Capture for Workforce in Motion GLOSSARY 47...

Page 4: ...rotocol v2 4 1 4 Data Capture for Workforce in Motion Revision History Changes to the original manual are listed below Document Date Description 2 4 0 10 July 06 Initial release 2 4 1 31 Dec 08 Upgrad...

Page 5: ...se our supported drivers whenever possible This document is intended for the use of clients who wish to use IDBlue on a platform for which Cathexis does not yet provide a software development kit SDK...

Page 6: ...IDBlue Communication Protocol v2 4 1 6 Data Capture for Workforce in Motion Document Conventions The following text conventions and symbols are used throughout this manual...

Page 7: ...rial port or the Bluetooth libraries provided by the platform and programming language Bluetooth PIN Code The default Bluetooth PIN code for all IDBlue devices is 0000 i e four zeroes This PIN code is...

Page 8: ...he device an asynchronous event is created sending a packet to the computer To designate this packet as an asynchronous event and not a possible response to an earlier command issued over the serial c...

Page 9: ...Tag IDs are sent and received in LSB order but need to be displayed as MSB order The byte array containing the tag ID should be reversed when either sending a command to the device or receiving a res...

Page 10: ...indicate with a green LED and audio beep if audio feedback is enabled Store Timestamp Tag Id Block 0 Data Store Timestamp Tag Id Block 0 Data Store Timestamp Tag Id Block 0 Data Store Timestamp Tag I...

Page 11: ...and audio beep if audio feedback is enabled An asynchronous READ_BLOCK response packet will be sent to the connected device Write Block N Write Block N Write Block N Write Block N In Write Block N mo...

Page 12: ...roperties Continuous Scanning Flag One of the powerful new features introduced in the 2 4 firmware release is the continuous scanning flag This mode enables each of the connected and disconnected asyn...

Page 13: ...ting mode these are the CONNECTEDMODE BLOCKINDEX BLOCKCOUNT and BLOCKDATA ConnectedMode sets the base operating mode with the data centric modes reading and writing using the other properties When upd...

Page 14: ...sent to the IDBlue device from the host They are used by the host to ask for information or for the device to perform some task Responses are sent to the from the IDBlue device They are the result se...

Page 15: ...IDBlue Communication Protocol v2 4 1 15 Data Capture for Workforce in Motion...

Page 16: ...host device when an error has occurred in processing the request packet or if the request could not be carried out properly It is also returned when a malformed or invalid request is sent e g invalid...

Page 17: ...GET_STATUS 23h Description This request returns status information about the device including battery level firmware version and hardware Parameters Battery level The battery life remaining for the d...

Page 18: ...is packet when it has finished streaming commands to the IDBlue device see REQ_START This request should only be issued if a REQ_START request has already been sent to the device or if the device is i...

Page 19: ...0 if the request failed Returns NACK if device could not be turned off BEEP 03h Description Causes the device to emit one of the standard audio tones or beeps Note if audio feedback is disabled throu...

Page 20: ...evice activation The session properties are configured using the SET_PROPERTY command Parameters Result 1 if successful 0 otherwise Returns SAVE_SESSION_AS_DEFAULT response packet or NACK if an error...

Page 21: ...to their default values when the device powers up In order to preserve configuration settings use the SAVE_SESSION_AS_DEFAULT command to save settings to EEPROM Parameters See Appendix A Properties R...

Page 22: ...uration methods that have been deprecated in favour of granular properties this method is retained for driver initialization When first connecting to a device any IDBlue driver requires the current RF...

Page 23: ...IDBlue device The default PIN is 0000 The PIN is usually a series of ASCII characters of length up to 16 characters Result 1 if the PIN was successfully changed 0 otherwise GET_BT_PIN 41h Description...

Page 24: ...will be displayed when a host scans for Bluetooth devices The name has a maximum length of 24 ASCII characters bytes Result 1 if the name was successfully changed 0 otherwise GET_BT_NAME 43h Descript...

Page 25: ...Data Capture for Workforce in Motion BLUETOOTH_OFF 92h Description This requests turns off the Bluetooth module on the device Parameters Result 1 on success 0 if the request failed Returns NACK if Bl...

Page 26: ...eve a single entry from the device tag memory database Parameters Index A 16 bit integer representing the index of the entry to read from the tag memory data Timestamp Timestamp for this entry Uses th...

Page 27: ...rotocol v2 4 1 27 Data Capture for Workforce in Motion CLEAR_ENTRIES 62h Description Clear the device tag memory database This deletes all entries stored on the device Parameters Result 1 on success 0...

Page 28: ...Note that tag data is not retrieved only the unique tag ID Parameters Tag id Unique tag identification number The least significant byte LSB of the tag id is sent first Note when developing a driver...

Page 29: ...tag id is sent first Block Index Index number of block in tag memory Block Data Data contained at the specified block index Returns READ_BLOCK response packet or NACK if not successful READ_MULTI 13h...

Page 30: ...WRITE_SINGLE 15h Description For supported tags this command will write one single block of tag memory as specified Parameters Tag id Unique tag id number of the tag to modify use all zeros 0 to write...

Page 31: ...ag id is sent first Block index Index number of block in tag memory at which to start writing Block count Number of blocks of memory to write starting from start index Data Block data to be written Re...

Page 32: ...OCK 19h Description This request will lock a single block of tag memory of a specified tag ID Memory will become read only This is useful for ensuring that data at a specified block cannot be altered...

Page 33: ...below are deprecated as of version 2 4 and will not be supported in firmware versions released after June 1st 2006 New implementations should avoid using these functions and existing implementations...

Page 34: ...field are None 00h ISO15693 01h Tag IT HF 02h PicoTag INSIDE Technologies 05h For more about supported RFID protocols please see Appendix A Result 1 if successful 0 otherwise Returns SET_RFID_PROTOCO...

Page 35: ...UZZER 2Ch Deprecated Description Allows the user to enable or disable the device buzzer Parameters Enabled Set to 0 to disable any other value to enable the buzzer Result 1 if successful 0 otherwise R...

Page 36: ...e 01h Sends an event to the host when the button is pressed This allows the host to control what operations will occur on a button press Read Block N 04h Performs a READ_BLOCK operation This mode is f...

Page 37: ...scription This request sets a timestamp on the IDBlue device IDBlue will update this timestamp accordingly once it was been assigned initially Parameters Year Month Day Hour Minute Second Result 1 if...

Page 38: ...compatible with IDBlue using the currently configured RFID protocol Store Timestamp Tag Id Block 0 Data 01h Reads the tag id and the first byte of block 0 and stores this information along with a time...

Page 39: ...eration e g read block write block WARNING setting the RFID op timeout to 0 zero will effectively disable all RFID operations The device may appear not to work Connected operating mode Operating modes...

Page 40: ...Inside PicoTag 05h Note None should only be used for testing purposes Configuring for this protocol will disable RFID functionality on the device Enable Buzzer Set to 0 to disable any other value to e...

Page 41: ...IDBlue Communication Protocol v2 4 1 41 Data Capture for Workforce in Motion Parameters Please see SET_DEFAULT_CONFIG parameters Returns GET_DEFAULT_CONFIG response packet or NACK...

Page 42: ...IDBlue Communication Protocol v2 4 1 42 Data Capture for Workforce in Motion Appendix A Properties...

Page 43: ...IDBlue Communication Protocol v2 4 1 43 Data Capture for Workforce in Motion...

Page 44: ...IDBlue Communication Protocol v2 4 1 44 Data Capture for Workforce in Motion...

Page 45: ...B Protocols Currently Supported Protocols Tag ITTM HF ISO 15693 2 includes Tag ITTM HFI and I CODE SLI tags PicoTag INSIDE Technologies The properties of each supported tag type are listed in Table 1...

Page 46: ...est response packet including header length and data The result of this operation is stored in a 1 byte or 8 bit field and attached to the end of the packet Example Below is a request packet for readi...

Page 47: ...ror checking over a communications channels such as a wireless Bluetooth link Also referred to as Checksum throughout this document The IDBlue serial protocol uses a simple XOR based method for CRC ca...