Micronas HAL 1820 Installation and operating instructions

Note
Application
Application Board HAL-APB V1.x
HAL®1820, HAL 24xy,
HAL 28xy, HAL 36xy,
HAL 38xy
Edition Oct. 8, 2012
APN000055_003EN

HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy APPLICATION NOTE
Application Board HAL-APB V1.x
2Oct. 8, 2012; APN000055_003EN Micronas
Copyright, Warranty,
and Limitation of
Liability
The information and data contained in this document are believed to be accurate and
reliable. The software and proprietary information contained therein may be protected
by copyright, patent, trademark and/or other intellectual property rights of Micronas. All
rights not expressly granted remain reserved by Micronas.
Micronas assumes no liability for errors and gives no warranty representation or guar-
antee regarding the suitability of its products for any particular purpose due to these
specifications.
By this publication, Micronas does not assume responsibility for patent infringements or
other rights of third parties which may result from its use. Commercial conditions, prod-
uct availability and delivery are exclusively subject to the respective order confirmation.
Any information and data which may be provided in the document can and do vary in
different applications, and actual performance may vary over time.
All operating parameters must be validated for each customer application by custom-
ers’ technical experts. Any new issue of this document invalidates previous issues.
Micronas reserves the right to review this document and to make changes to the docu-
ment’s content at any time without obligation to notify any person or entity of such revi-
sion or changes. For further advice please contact us directly.
Do not use our products in life-supporting systems, military, aviation, or aerospace
applications! Unless explicitly agreed to otherwise in writing between the parties, Micro-
nas’ products are not designed, intended or authorized for use as components in sys-
tems intended for surgical implants into the body, or other applications intended to sup-
port or sustain life, or for any other application in which the failure of the product could
create a situation where personal injury or death could occur.
No part of this publication may be reproduced, photocopied, stored on a retrieval sys-
tem or transmitted without the express written consent of Micronas.
Micronas Trademarks HAL, varioHAL, 1D HAL, 2D HAL, 3D HAL
Third-Party Trademarks All other brand and product names or company names may be trademarks of their
respective companies.
License Note HAL36xy and HAL38xy use licenses of Fraunhofer Institute for Integrated Circuits IIS.

APPLICATION NOTE HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy
Application Board HAL-APB V1.x
Micronas Oct. 8, 2012; APN000055_003EN 3
Contents
Page Section Title
6 1. Introduction
6 1.1. General Information
6 1.2. Introduction
7 1.2.1. Supported HAL Sensors
7 1.2.2. Sensor-specific PC Software
8 1.3. Board Block Diagram
9 2. Getting started
9 2.1. First Steps
9 2.1.1. Check HAL-APB V1.x
9 2.1.2. Check Communication with PC and Hall Sensor Connection
10 3. Board Configuration
10 3.1. Jumper Settings
13 3.2. HAL Interface Connector
13 3.3. Firmware update
14 4. Specification
14 4.1. Recommended Operating Conditions
14 4.2. Recommended Wiring
15 4.3. Maintenance and Calibration
16 4.4. Characteristics
17 5. USB Driver Installation
17 5.1. Installing the USB VCP Drivers
18 6. Board Functions
18 6.1. Serial Command Interpreter
18 6.1.1. Serial Interface Configuration
18 6.1.2. Definition of the COMMAND Frame
18 6.1.3. Definition of the RESPONSE Frame
19 6.1.4. Analog Measurements
20 6.1.5. Error Codes
21 7. Board Mode Settings
21 7.1. Board Operation Modes
21 7.2. Board Configuration Commands

HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy APPLICATION NOTE
Application Board HAL-APB V1.x
4Oct. 8, 2012; APN000055_003EN Micronas
24 8. HAL 1820
24 8.1. Programming interface
25 8.2. Command Structures of Protocol
26 8.3. Telegram Parameters
27 8.4. Available sensor commands
27 8.4.1. Read
27 8.4.2. Write
27 8.4.3. Protocol Error Handling
28 8.4.4. Data check
28 8.4.5. CRC
28 8.4.6. Parity check
29 8.5. HAL 1820 - Board commands
30 8.6. Locking of the Sensor
31 9. HAL24xy
31 9.1. Programming interface
32 9.2. Command Structure of Protocol for communication via VSUP
33 9.3. Command Structure of Protocol for communication via OUT-Pin
34 9.4. Telegram Parameter
35 9.5. Available sensor commands
35 9.5.1. Set base address
35 9.5.2. Read
35 9.5.3. Write
35 9.5.4. CRC
36 9.5.5. Parity check
36 9.5.6. Protocol Error Handling
37 9.6. HAL 24xy - Board commands
38 9.7. Locking of the Sensor
39 10. HAL 2810 – Board Commands
39 10.1. LIN Interface
39 10.1.1. LIN Interface Mode Configuration
39 10.1.2. Schedule Tables
40 10.1.3. Error Handling
41 10.2. HAL 2810 (LIN2.0) – Board commands
42 10.3. Locking of the Sensor
43 11. HAL 283x / HAL 2850
43 11.1. Programming interface
44 11.2. Command Structure of Protocol for communication via OUT-Pin
45 11.3. Telegram Parameters
46 11.4. Available sensor commands
46 11.4.1. Set base address
46 11.4.2. Read with absolute address
46 11.4.3. Read with base address
47 11.4.4. Write byte with base address
47 11.4.5. Write word with base address
47 11.4.6. Special Cases
47 11.4.7. Protocol Error Handling
48 11.5. HAL 283x / HAL 2850 – Board commands
49 11.6. Locking of the Sensor

APPLICATION NOTE HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy
Application Board HAL-APB V1.x
Micronas Oct. 8, 2012; APN000055_003EN 5
50 12. HAL 3625, HAL 3675, HAL 385x and HAL 387x
50 12.1. Programming interface
51 12.2. Command Structure of Protocol for communication via VSUP
52 12.3. Telegram Parameters
53 12.4. Command Structure of Protocol for communication via OUT-Pin
54 12.5. Telegram Parameter
55 12.6. Available sensor commands
55 12.6.1. Set base address
55 12.6.2. Read
55 12.6.3. Write
55 12.6.4. CRC
56 12.6.5. Parity check
56 12.6.6. Protocol Error Handling
57 12.7. HAL 3625, HAL 3675, HAL 385x and HAL 385x– Board commands
58 12.8. Locking of the Sensor
59 13. Application Note History

HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy APPLICATION NOTE
Application Board HAL-APB V1.x
6Oct. 8, 2012; APN000055_003EN Micronas
Release Note: Revision bars indicate significant changes to the previous edition.
1. Introduction
1.1. General Information
The hardware and software description in this document is valid for the Application
Board HAL-APB V1.x.
Fig. 1–1: Application Board HAL-APB V1.x
1.2. Introduction
The Application Board HAL-APB V1.x (HAL-APB) is an board for programming the
Micronas Hall-effect sensor families with analog and digital output formats. The board
is equipped with a Micronas Flash micro controller CDC 3207G. It provides an applica-
tion software supporting a command interface for the communication with a PC. This
allows the implementation of specific PC software for engineering purposes or in-line
calibration. The HAL-APB can be ordered with a housing or as a PCB version.
In the case of a housing, an additional extension board with two sockets for the connec-
tion of up to two Hall sensors (depending on the sensor type) is supplied.
Two versions of the Application Board HAL-APB are in use: version 1.3 and the
updated version 1.5. Both versions are free to be used in laboratories for engineering
purposes.
Note: For usage in the production, board version 1.5 is mandatory.

APPLICATION NOTE HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy
Application Board HAL-APB V1.x
Micronas Oct. 8, 2012; APN000055_003EN 7
1.2.1. Supported HAL Sensors
The HAL-APB supports the sensors listed in Ta b l e 1 – 1 .
Please refer to the corresponding Programming Guides Application Notes for detailed
information on the sensors listed or contact the Application Support Sensors
([email protected]m).
1.2.2. Sensor-specific PC Software
Micronas GmbH provides easy-to-use PC software (LabView) for each supported sen-
sor.
Table 1–1: Supported sensors
Sensor Remark
HAL 1820 Linear sensor with analog output
HAL 242x Linear sensor with analog output
HAL 2810 Linear sensor with LIN 2.0 Interface
HAL 283x Linear sensor with SENT Interface
HAL 2850 Linear sensor with fast PWM output
HAL 3625 Direct angle sensor with analog output
HAL 3675 Direct angle sensor with PWM output
HAL 385x 2D position sensor with analog output
HAL 387x 2D position sensor with PWM output

HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy APPLICATION NOTE
Application Board HAL-APB V1.x
8Oct. 8, 2012; APN000055_003EN Micronas
1.3. Board Block Diagram
Fig. 1–2: HAL-APB block diagram
Fig. 1–3: Detailed view of HAL Interface
5V-MCU 5V-ANA Module
5V-PER
OLED
Extension
(optional)
LIN
(optional)
Hall
Interface
MCU
CDC3207
USB
RS232
EEPROM
JTAG
V_Board
GND
Voltage
Reference
VDD_Hall Driver
Switch
V_Board
VDD
Slew
Control
(Optional)
Voltage Level
Control
Switch
Digital
Transceiver
VOUT_1
VOUT_2
GND
Hall device
A/D
Sens
GND
MCU
A/D
Sens
VOUT1
TP8 - IDD
TP VDD
VDD/3

APPLICATION NOTE HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy
Application Board HAL-APB V1.x
Micronas Oct. 8, 2012; APN000055_003EN 9
2. Getting started
2.1. First Steps
2.1.1. Check HAL-APB V1.x
– Connect the HAL-APB to the supply voltage.
– Check if the power-on self-test was passed successfully. (ERROR LED is switched
off after power on. Exception: LIN mode)
Board Supply
The HAL-APB requires a stabilized power supply. For this purpose, either when using it
without housing, the connector X2 (DC jack) or the terminal beneath it can be used.
Power-On Self-Test
The HAL-APB firmware provides a power-on self-test. The self-test is started after con-
necting the board supply. During the self-test, the status LEDs including the Error LED,
will flash.
In case of a detected error, the ERROR LED remains illuminated after the self-test. In
LIN mode the ERROR LED is switched on as long as the Vsupply of the sensor is not
set to 12 V.
2.1.2. Check Communication with PC and Hall Sensor Connection
Connect a Hall sensor with the HAL-APB.
(a) directly into the socket HAL 1
or
(b) into one of the sockets of the HAL-APB extension board (housing version).
Note: For the first communication check, we recommend using the sensor specific
Programming Environment LabView software provided by Micronas for the spe-
cific HAL sensor.
you can also
– set up a Hyperterminal connection (see Section 6 on page 18)
– switch Vdd on using the “vho1” command (see Section 7.2 on page 21).
– try to read out a register (see chapter of the used sensor type).

HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy APPLICATION NOTE
Application Board HAL-APB V1.x
10 Oct. 8, 2012; APN000055_003EN Micronas
3. Board Configuration
3.1. Jumper Settings
For changing between LIN-Bus and Biphase-M communication, jumpers need to be set
differently. For non-housed (optional) application boards it may be necessary to switch
jumper for USB/RS-232 connection. The following pictures show how to set the jump-
ers correctly.
Fig. 3–1: Jumper settings HAL-APB V1.x
The default jumper position Pos1 is indicated by black bars in Fig. 3–1.
Note: For board versions higher than v1.3, no manual adjustment is required. The
HAL-APB firmware automatically detects the appropriate protocol to be used for
the Hall sensor.
X4 - RS232
(SUB-D-9) USB
(B)
X3
X2
+18 VDC

CDC3207G
JP1
JP4
HAL1
HAL1/2
Reset
TP7
TP8
JP7
JP5
JP6
HAL-APB
Version 1.3
SW
JP3
Status LEDs on housing
Status LEDs
RJ-45
X4 - RS232
(SUB-D-9) USB
(B)
X3
X2
+18 VDC

CDC3207G
JP1
HAL1
HAL1/2
Reset
TP7
TP8
HAL-APB
Version 1.5
SW
JP3
Status LEDs on housing
Status LEDs
RJ-45
JP2
JP5
JP4

APPLICATION NOTE HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy
Application Board HAL-APB V1.x
Micronas Oct. 8, 2012; APN000055_003EN 11
Table 3–2: Jumper settings
Jumper Setting Function
JP1 pos1 (default)
pos2
debug
normal operation
JP2 V1.5
open (default)
close
communication via RS232
manual MCU reset during firm-
ware flash
automatic MCU reset during
firmware flash
V1.3
pos1 (default)
pos2
normal operation
reserved
JP3 close (default)
open
USB
RS-232
JP4 close (default)
open
VDD_Hall equals GND when
Vsup is switched off
VDD_Hall is floating when
Vsup is switched off
JP5 V1.5
open (default)
close
communication via USB
manual MCU reset during firm-
ware flash
automatic MCU reset during
firmware flash
V1.3
close (default)
open
normal operation
only for LIN Bus applications
JP6 (only V1.3) close (default)
open
normal operation
only for LIN Bus applications
JP7 (only V1.3) open (default)
close
normal operation
only for LIN bus applications
Note: JP7 must not be set in combination with JP4 and JP5 (only V1.3)

HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy APPLICATION NOTE
Application Board HAL-APB V1.x
12 Oct. 8, 2012; APN000055_003EN Micronas
Table 3–3: Board LED description
LED Name Function
ERROR On, in case of communication error
READY On, after power-on of board
PCCOM On, in case of communication between PC and HAL-
APB
HAL_RD Telegram on VOUT
HAL_PR reserved
HAL_WR Telegram high level on Hall VDD
HAL_ON Hall VDD on

APPLICATION NOTE HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy
Application Board HAL-APB V1.x
Micronas Oct. 8, 2012; APN000055_003EN 13
3.2. HAL Interface Connector
Depending on the sensor type, up to two sensors can be connected to the board. For
this purpose, a 6-pin connector HAL1/2 is provided. Alternatively, one Hall Sensor can
be inserted in the 3-pin socket HAL beneath the connector HAL1/2 (only available for
boards without housing).
The following pin’s are connected in parallel Pin No. 1(VSUPSensor1) and 4
(VSUPSensor2) and Pin No. 2 (Common Sensor GND) and Pin No. 5 (Common Sensor
GND). The male plug (modular RJ-12, OST (MMJ) coding) corresponding to the fawn
connector HAL1/2 can be ordered from every electronics store. The pinning of the inter-
face is described in Ta b l e 3 – 4 .
Fig. 3–2: Modular connector HAL1/2, front view
3.3. Firmware update
The procedure for a firmware update of the HAL-APB V1.x is provided in the Applica-
tion Note “Firmware Update HAL-APB V1.x”
Table 3–4: Pinning of the HAL interface HAL1/2
Pin No. Description
1 Sensor input
VSUP Sensor 1
2 Common Sensor GND
3 Sensor output VOUT/DIO Sensor 1
4 Sensor input
VSUP Sensor 2
5 Common Sensor GND
6 Sensor output VOUT/DIO Sensor 2

HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy APPLICATION NOTE
Application Board HAL-APB V1.x
14 Oct. 8, 2012; APN000055_003EN Micronas
4. Specification
4.1. Recommended Operating Conditions
All voltages are referenced to GND (-VB pin at X1 = GND at X2)
4.2. Recommended Wiring
We recommend connecting the application to the board using shielded wires.
In order to minimize the risk of electromagnetic disturbances, the cable should be as
short as possible.
Note: Especially in noisy environments beneath power switches, electromagnetic
actuators, and the like, EMI-compliant layout of the wiring is mandatory.
For recommended cable parameters, please refer to Table 4–6.
Table 4–5: Board conditions
Symbol Parameter Connector Limit Values Unit Test Conditions
Min. Typ. Max.
ISUP Supply Current X2 - 180 - mA
VSUP Supply Voltage X2 16 18 20 V
CLLoad Capacitance HAL1/2 - - 100 nF

APPLICATION NOTE HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy
Application Board HAL-APB V1.x
Micronas Oct. 8, 2012; APN000055_003EN 15
4.3. Maintenance and Calibration
We recommend sending the programmer board back to the supplier for maintenance
and calibration of the voltage levels after one year of operation.
The Hall programmer board must not be maintained or repaired by the customer. In
case of any problems or defects, please contact your supplier.
WARNING: Do not modify any part of the Hall programmer board V 1.x, nor readjust
any trimming potentiometer. Otherwise, the board may be damaged, the
sensor programming may be insufficient, and the reliability of the sensor
reduced.
Fig. 4–3: Recommended wiring - schematic sketch
Customer Application
VDD
GND
VOUT
Programmer Board V 1.x
L
Table 4–6: Recommended cable parameters
Symbol Parameter Min. Typ. Max. Unit Conditions
R0Ohmic Resistance per Wire 15I < 10 mA
C0Capacitance 80 120 pF
Z Impedance 50 
L Length 1m

HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy APPLICATION NOTE
Application Board HAL-APB V1.x
16 Oct. 8, 2012; APN000055_003EN Micronas
4.4. Characteristics
All voltages are referenced to GND (-VB pin at X1 = GND at X2)
Note: The voltage levels are trimmed by the manufacturer. If any of the levels listed are
found to be outside the specification limits, please contact the manufacturer or
the Application Support Sensors Team.
The RS232 cable should be a standard serial cable. Also called straight cable.
Table 4–7: Board characteristics
Symbol Parameter Connector Limit Values Unit Test Conditions
Min. Typ. Max.
ISUP_HAL Output Load Current HAL1/2 - - 40 mA Supply current per
device
VOUT_HAL Output Voltage of Hall
Device
HAL1/2 0
0
-5
18
V
V
Standard configuration
(default)
LIN configuration only!
VSUP_HAL_NORM NORM Level of HAL Supply
Voltage
HAL 1/2 4.9 5 5.1 V
VSUP_HAL_LOW LOW Level of HAL Supply
Voltage
HAL 1/2 5.8 6.0 6.6 V
VSUP_HAL_HIGH HIGH Level of HAL Supply
Voltage
HAL 1/2 6.8 7.3 7.8 V

APPLICATION NOTE HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy
Application Board HAL-APB V1.x
Micronas Oct. 8, 2012; APN000055_003EN 17
5. USB Driver Installation
Note: When using the serial cable you do not need to install this drivers. They are only
necessary for connecting the Application Board HAL-APB V1.x via USB cable to
the PC.
5.1. Installing the USB VCP Drivers
Plug in the Application Board HAL-APB V1.x (Power supply also connected) into a
spare USB port and plug in the power supply.
Windows 7 will automatically search latest driver if the PC is connected to the internet.
If there are problems with the installation follow the application note:
“AN_119_FTDI_Drivers_Installation_Guide_for_Windows7.pdf”
The application note: “AN_104_FTDI_Drivers_Installation_Guide_for_WindowsXP.pdf”
can be used to install the driver on a windows xp system.
The application note can be either found on the Micronas Service Portal
(https://service.micronas.com/workgroups/) or on the FTDI homepage.
Note: Sometimes the installer repeats the whole procedure. If this happens please do
the same as explained above again.

HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy APPLICATION NOTE
Application Board HAL-APB V1.x
18 Oct. 8, 2012; APN000055_003EN Micronas
6. Board Functions
6.1. Serial Command Interpreter
This board provides a serial command interpreter for the interaction with a PC, con-
nected via USB or RS232.
The serial communication protocol applies a software handshake:
– The PC acts as a master, the HAL-APB V1.x as slave,
– The HAL-APB V1.x responds to each master COMMAND frame with a RESPONSE
frame.
6.1.1. Serial Interface Configuration
When using a hyperterminal communication please set the following parameters.
6.1.2. Definition of the COMMAND Frame
The command frame is of variable length. There are basically two types of commands:
1. for board configuration
2. for communication with connected Hall device
The command string has to end with <CR> (ASCII character 0x0D), optionally with
<CR><LF> (ASCII characters 0x0D, 0x0A).
6.1.3. Definition of the RESPONSE Frame
The response frame consists of 7...10 characters plus 1 finishing <LF>
<ST>:<R9><R8>....<R2><R1><R0> <LF>
ST is non-zero in case of errors (see Ta b l e 6 – 9 )
Table 6–8: parameter settings of serial interface
Parameter Value
Bits per second 38400
Data bits 8
Parity Even
Stop bits 1
Flow control none

APPLICATION NOTE HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy
Application Board HAL-APB V1.x
Micronas Oct. 8, 2012; APN000055_003EN 19
The Rx-characters contain the received data depending on the command (see device-
dependent command lists in section 9, 10,...).
6.1.4. Analog Measurements
Its also possible to measure analog voltages, as the HAL_VDD or the HAL_VOUT with
the ADC of the HAL-APB. The HAL_OUT is only correctly measurable when HAL_VDD
equals 5 V.
Example
ftvdl0 (set VDD to 5 V)
ftana1 (measure HAL_VDD)
ftana2 (measure HAL_VOUT)
VDD = DATA / 1024 x 3 x 5V
VOUT = DATA / 1024 x 5V
DATA is measured by ftana command as explained in Table 7–11.

HAL1820, HAL24xy, HAL28xy, HAL36xy, HAL38xy APPLICATION NOTE
Application Board HAL-APB V1.x
20 Oct. 8, 2012; APN000055_003EN Micronas
6.1.5. Error Codes
Table 6–9: Error codes
STATUS Error
0 no error
1 acknowledge error
2 2’nd Acknowledge error
3 invalid command for selected
Mode
4 PID in running table cannot be
modified (LIN)
5 LIN communication Error
6 LIN interface connection Error
7 no PWM (at PWM Duty Cycle
read command)
8reserved
9reserved
10 (0xA) reserved
11 (0xB) reserved
12 (0xC) reserved
13 (0xD) data read error
14 (0xE) invalid command parameter
15 (0xF) invalid command