1. DL manuals
  2. Baracoda
  3. Scanner
  4. IDBlue
  5. Supplementary Manual

Baracoda IDBlue Supplementary Manual

Other manuals for IDBlue: Compatibility Manual, Specifications, User Manual
Manual is about: Communication Protocol

Summary of IDBlue

  • Page 1

    Data capture for workforce in motion idblue communication protocol ©baracoda tm – december 2008.

  • Page 2

    Idblue – communication protocol v2.4.1 - 2 - data capture for workforce in motion summary summary ................................................................... 2 revision history .......................................................... 4 document conventions ....................................

  • Page 3

    Idblue – communication protocol v2.4.1 - 3 - data capture for workforce in motion glossary ................................................................. 47.

  • Page 4

    Idblue – communication protocol 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 upgrade graphic presentation.

  • Page 5

    Idblue – communication protocol v2.4.1 - 5 - data capture for workforce in motion introduction overview the intent of this document is to provide software developers with a general specification for interfacing with the idblue™ device. It provides a description of the byte-level protocol used to com...

  • 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

    Idblue – communication protocol v2.4.1 - 7 - data capture for workforce in motion communication overview in order to communicate with idblue™, a bluetooth® connection must be established to the device using the serial port profile (spp). It is beyond the scope of this document on how to establish th...

  • Page 8

    Idblue – communication protocol v2.4.1 - 8 - data capture for workforce in motion packet structure packets are a sequence of bytes sent to the idblue device via a serial port connection. The table below shows the formatting for all request and response packets used to communicate with the idblue™ de...

  • Page 9

    Idblue – communication protocol v2.4.1 - 9 - data capture for workforce in motion developer tips • 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 re...

  • Page 10

    Idblue – communication protocol v2.4.1 - 10 - data capture for workforce in motion device operating modes the idblue™ device has a number of operating modes, each performing different operations when the hardware button the device is pressed. These modes are divided into connected modes (when the de...

  • Page 11

    Idblue – communication protocol v2.4.1 - 11 - data capture for workforce in motion connected mode normal normal normal normal in normal mode, when the hardware button is pressed, the device will: • indicate a start of rfid operations by turning the led orange • attempt to scan a tag using the curren...

  • Page 12

    Idblue – communication protocol v2.4.1 - 12 - data capture for workforce in motion device configuration the idblue™ device supports a number of configuration properties. These properties are either persistent properties (saved to the on-board eeprom, and “remembered” when the device is shut down), o...

  • Page 13

    Idblue – communication protocol v2.4.1 - 13 - data capture for workforce in motion connected mode parameters four configuration properties affect the connected operating mode; these are the connectedmode, blockindex, blockcount and blockdata. Connectedmode sets the base operating mode, with the data...

  • Page 14

    Idblue – communication protocol v2.4.1 - 14 - data capture for workforce in motion commands communication between the idblue™ device and host occurs using a series of requests and responses. Requests are packets sent to the idblue™ device from the host. They are used by the host to ask for informati...

  • Page 15

    Idblue – communication protocol v2.4.1 - 15 - data capture for workforce in motion.

  • Page 16

    Idblue – communication protocol v2.4.1 - 16 - data capture for workforce in motion responses this section describes the stock responses which can be returned from the device. Note: most commands have a custom response format, which is described in the command definition. Ack (f1h) description some r...

  • Page 17

    Idblue – communication protocol v2.4.1 - 17 - data capture for workforce in motion core functions no_op (00h) description this request does nothing. It may be used to verify that an idblue™ device is connected. It returns an ack packet as response. Parameters none. Get_status (23h) description this ...

  • Page 18

    Idblue – communication protocol v2.4.1 - 18 - data capture for workforce in motion req_start (80h) description this request signals the start of one or more reactive mode requests. The host should send this packet when it receives a button press event from the idblue™ device, and then proceeds to st...

  • Page 19

    Idblue – communication protocol v2.4.1 - 19 - data capture for workforce in motion power_down (91h) description this requests the device to turn off. It offers a method to shut down the idblue™ device from a software application. Parameters result 1 on success, 0 if the request failed. Returns nack ...

  • Page 20

    Idblue – communication protocol v2.4.1 - 20 - data capture for workforce in motion configuration functions save_session_as_default (10h) [new] description saves the session configured properties as the default configuration, which is written to eeprom and loaded on device activation. The session pro...

  • Page 21

    Idblue – communication protocol v2.4.1 - 21 - data capture for workforce in motion set_property (08h) [new] description configures a property of the device. This property is set for the duration of the session (i.E. While the device remains powered). Note: as described on page 15, all properties are...

  • Page 22

    Idblue – communication protocol v2.4.1 - 22 - data capture for workforce in motion get_current_config (2fh) description this requests the current device configuration settings. The response format and parameters for this request are given below. As opposed to the other property specific and aggregat...

  • Page 23

    Idblue – communication protocol v2.4.1 - 23 - data capture for workforce in motion bluetooth functions set_bt_pin (40h) description assign a new bluetooth® pin for secured connection to the idblue™ device. Parameters pin the bluetooth® security pin for connecting to the idblue™ device. The default p...

  • Page 24

    Idblue – communication protocol v2.4.1 - 24 - data capture for workforce in motion set_bt_name (42h) description assign a new bluetooth® name to the idblue™ device. Parameters name this is the display name of the idblue™ device. This identifying name will be displayed when a host scans for bluetooth...

  • Page 25

    Idblue – communication protocol v2.4.1 - 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 bluetooth module could not be turned off..

  • Page 26

    Idblue – communication protocol v2.4.1 - 26 - data capture for workforce in motion internal database functions get_entry_count (60h) description retrieve the number of entries in the device tag memory database. Parameters entry count a 16-bit integer representing the number of entries in the tag mem...

  • Page 27

    Idblue – communication protocol 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 if the request failed..

  • Page 28

    Idblue – communication protocol v2.4.1 - 28 - data capture for workforce in motion rfid commands this section describes all of the rfid-specific commands that are used to select tag id’s, and read and write on-board tag data. Get_tag_id (01h) description returns the tag id of the first tag found in ...

  • Page 29

    Idblue – communication protocol v2.4.1 - 29 - data capture for workforce in motion read_single (12h) description for supported tags, this command will read a single block of tag memory as specified. Parameters tag id tag id of tag to read. (use all zeros (0) to read any tag). The least-significant b...

  • Page 30

    Idblue – communication protocol v2.4.1 - 30 - data capture for workforce in motion block count number of blocks of memory to read, beginning at start index. Block data returned block data from the tag. Returns read_blocks response packet, or nack is not successful. Write_single (15h) description for...

  • Page 31

    Idblue – communication protocol v2.4.1 - 31 - data capture for workforce in motion write_multi (16h) description for supported tags, this command will write multiple blocks of tag memory as specified. Parameters tag id unique tag id number of the tag to modify (use all zeros (0) to write to any tag)...

  • Page 32

    Idblue – communication protocol v2.4.1 - 32 - data capture for workforce in motion parameters tag id unique tag id number of the tag to lock (use all zeros (0) to use any tag). The least-significant byte (lsb) of the tag id is sent first. Block size size of each data block in bytes. Block count tota...

  • Page 33

    Idblue – communication protocol v2.4.1 - 33 - data capture for workforce in motion deprecated functions the functions 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 exis...

  • Page 34

    Idblue – communication protocol v2.4.1 - 34 - data capture for workforce in motion set_rfid_protocol (20h) [deprecated] description this command will configure the device to operate using a specified air interface protocol. On power- up, the device defaults to the default rfid protocol (see set_defa...

  • Page 35

    Idblue – communication protocol v2.4.1 - 35 - data capture for workforce in motion set_current_config (2eh) [deprecated] description this request changes the current configuration settings of the device. This request does not affect default settings for the device. The format and parameters for this...

  • Page 36

    Idblue – communication protocol v2.4.1 - 36 - data capture for workforce in motion set_connected_ mode (24h) [deprecated] description this request changes the current connected operating mode of the device (see below for possible modes of operation). Parameters operating mode operating modes for the...

  • Page 37

    Idblue – communication protocol v2.4.1 - 37 - data capture for workforce in motion parameters operating mode operating modes for the device (when connected to a host): returns get_connected_mode response packet or nack. Set_time (28h) [deprecated] description this request sets a timestamp on the idb...

  • Page 38

    Idblue – communication protocol v2.4.1 - 38 - data capture for workforce in motion returns get_time response packet or nack if an error occurred. Set_disconnected_ mode (2ah) [deprecated] description this request changes the current disconnected operating mode of the device (see below for possible m...

  • Page 39

    Idblue – communication protocol v2.4.1 - 39 - data capture for workforce in motion set_default_config (26h) [deprecated] description this request changes the default configuration settings of the device. Do not send this request more than is required! The settings are stored on the device eeprom and...

  • Page 40

    Idblue – communication protocol v2.4.1 - 40 - data capture for workforce in motion disconnected operating mode disconnected operating modes for the device: tag verify (00h) allows users to verify if a tag is compatible with idblue using the currently configured rfid protocol. Store timestamp + tag i...

  • 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

    Idblue – communication protocol v2.4.1 - 45 - data capture for workforce in motion appendix 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 tab...

  • Page 46

    Idblue – communication protocol v2.4.1 - 46 - data capture for workforce in motion appendix c - checksum generation current versions of idblue™ use a simple xor checksum algorithm. The checksum is generated by xor’ing all bytes in a request/response packet, including header, length, and data. The re...

  • Page 47

    Idblue – communication protocol v2.4.1 - 47 - data capture for workforce in motion glossary block information that is digitally stored on a rfid tag is organized as a series of blocks. Typically, each block consists of 4 to 8 bytes of data and a single tag may contain up to 256 individual blocks. Bl...