Calibre UK UCA93 manual

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

Go to page of

A good user manual

The rules should oblige the seller to give the purchaser an operating instrucion of Calibre UK UCA93, along with an item. The lack of an instruction or false information given to customer shall constitute grounds to apply for a complaint because of nonconformity of goods with the contract. In accordance with the law, a customer can receive an instruction in non-paper form; lately graphic and electronic forms of the manuals, as well as instructional videos have been majorly used. A necessary precondition for this is the unmistakable, legible character of an instruction.

What is an instruction?

The term originates from the Latin word „instructio”, which means organizing. Therefore, in an instruction of Calibre UK UCA93 one could find a process description. An instruction's purpose is to teach, to ease the start-up and an item's use or performance of certain activities. An instruction is a compilation of information about an item/a service, it is a clue.

Unfortunately, only a few customers devote their time to read an instruction of Calibre UK UCA93. A good user manual introduces us to a number of additional functionalities of the purchased item, and also helps us to avoid the formation of most of the defects.

What should a perfect user manual contain?

First and foremost, an user manual of Calibre UK UCA93 should contain:
- informations concerning technical data of Calibre UK UCA93
- name of the manufacturer and a year of construction of the Calibre UK UCA93 item
- rules of operation, control and maintenance of the Calibre UK UCA93 item
- safety signs and mark certificates which confirm compatibility with appropriate standards

Why don't we read the manuals?

Usually it results from the lack of time and certainty about functionalities of purchased items. Unfortunately, networking and start-up of Calibre UK UCA93 alone are not enough. An instruction contains a number of clues concerning respective functionalities, safety rules, maintenance methods (what means should be used), eventual defects of Calibre UK UCA93, and methods of problem resolution. Eventually, when one still can't find the answer to his problems, he will be directed to the Calibre UK service. Lately animated manuals and instructional videos are quite popular among customers. These kinds of user manuals are effective; they assure that a customer will familiarize himself with the whole material, and won't skip complicated, technical information of Calibre UK UCA93.

Why one should read the manuals?

It is mostly in the manuals where we will find the details concerning construction and possibility of the Calibre UK UCA93 item, and its use of respective accessory, as well as information concerning all the functions and facilities.

After a successful purchase of an item one should find a moment and get to know with every part of an instruction. Currently the manuals are carefully prearranged and translated, so they could be fully understood by its users. The manuals will serve as an informational aid.

Table of contents for the manual

  • Page 1

     Calibre UK Ltd 2003  CALIBRE UCA 93 I2C Communi cations A dap ter Issue 1.0 01/07/2003[...]

  • Page 2

    CALIBRE Issue 1.0 Page i 01/07/03 Welcome to t he Calibre UCA93 adjustab le voltage I 2 C Adapter. T his Adapter provid es full I 2 C bi-directional compatibility as either a master or slave from within a Windows 98 2000 or Windows X P environment. If you have an y queries relating to this o r any other I 2 C product supplied by Calibre please visi[...]

  • Page 3

    CALIBRE Issue 1.0 Page ii 01/07/03 Contents INTRODUCT ION 1 1.1. General Introduc tion 1 1.2. Pack ing List 1 1.3. Configuring the Adapter 1 1.4. Bus T erm ination and Protection 1 1.5. Connecting the Adapter to your Sy stem 1 1.6. Bus Capacitance Lim itations/Cable Choic e 2 1.7. Variable Voltage Bus Power Supply 2 INSTALLING T HE ADAPTER UNDER W [...]

  • Page 4

    CALIBRE Issue 1.0 Page 1 01/07/03 INTRODUCT ION 1.1. General Intr oduction The UCA93 is a USB V1.1 to I 2 C Adapter based on the PIC 16F 874 mic rocontroller using a Philips PCF8584 for the bus m onitor func tion. It features f ull I 2 C bi-directional com patibility as either a m aster or slave. I 2 C connections are m ade via a 9 way “ D” soc[...]

  • Page 5

    CALIBRE Issue 1.0 Page 2 01/07/03 IO 1 is a 5V T TL input and c an only be us ed on 5V tolerant systems . Pin Function 1 NC – DO NOT CONNECT 2I O 0 3I O 1 40 V 1.6. Bus Cap acitance Limitatio ns/Cable Choice The m axim um allowable capacitance on the I 2 C bus in norm al m ode depends on the value of the SCL and SDA master pull-ups, but never exc[...]

  • Page 6

    CALIBRE Issue 1.0 Page 3 01/07/03 INSTALLING THE A DA PT ER UNDER WINDOWS 2.1. Introduc tion This section details the installation of the UCA93 I 2 C com munic ations Adapter under W indows 98® / W indows2000® and W indows XP®. The appearanc e of the dialog boxes during the installation of new hardware varies depending on the version of W indows[...]

  • Page 7

    CALIBRE Issue 1.0 Page 4 01/07/03 LIBRA RIES FOR PROGRAMMING IN M ICROSOFT W INDOWS ENVIRONM ENTS 3.1. Introduc tion Each utility is documented in a s tandard for mat which lis ts its nam e, usage, f unction and ef fect on the Adapter is given. T he Adapter should be setup pr ior to any data transfer. W ithin the DLL there are two versions of som e[...]

  • Page 8

    CALIBRE Issue 1.0 Page 5 01/07/03 3.2. Function Prototy pes If you are using ‘C’ or ‘C++’ copy the file CALUCA.H into the directory containing your project and add the line: #include " CALUCA.H" The f ollowing functions ar e implem ented in the windows libraries:- extern __decls pec(dllim port) int W INAPI Setup (int, int, int, in[...]

  • Page 9

    CALIBRE Issue 1.0 Page 6 01/07/03 If y ou are using Visual Basic c opy the f ile UCA93LV.BAS into the director y c ontaining y our project and add the file UCA93LV.BAS to your project: The f ollowing functions ar e implem ented in the windows libraries:- Public Declare F unction Setup% Lib "USBDLL_XP.dll" (ByVal OwnAddress%, ByVal Sclk%, [...]

  • Page 10

    CALIBRE Issue 1.0 Page 7 01/07/03 3.3. Function Description 3.3.1. Setup Function specif ication int Setup(int OwnAddress, int Clock Speed, int BusVoltage, int PullUpsOn, int SlaveBlock Tim eout) Parameters are: int ownaddress This is the I2C address to which the Adapter is to r espond in slave m ode. T his form s the upper 7 bits of the 8 bit addr[...]

  • Page 11

    CALIBRE Issue 1.0 Page 8 01/07/03 Wr i t e B y t e Function spec ification Int W riteByte(int DataBy te) Parameters are: int DataByte This is the byte of data to be written. Parameters returned int ErrCode . If the trans fer tim e out occ urs error code 8002H is returned otherwise the status is returned. Prerequisites Adapter m ust be conf igured u[...]

  • Page 12

    CALIBRE Issue 1.0 Page 9 01/07/03 Usually a data pointer would already have been written using WriteByte. Functional desc ription Sends a start code and the s lave address. The func tion waits f or the address to be sent. Should a tim e-out oc cur during the sending of an addr ess then an error code 8004H is r eturned, otherwise the status is retur[...]

  • Page 13

    CALIBRE Issue 1.0 Page 10 01/07/03 3.3.9. Block W rite Function spec ification void Block W rite(int SlaveW riteAddres s, int MSB_W ordAddres s, int LSB_W ordAddress,int NoBytesToSend, int NoT ries ) Parameters are: int SlaveAddress This is the address to be access ed via the I2C, e.g. A0H int MSB_W or dAddress , int LSB_W ordAddress This is the lo[...]

  • Page 14

    CALIBRE Issue 1.0 Page 11 01/07/03 This is the num ber of tim es the Adapter is to try to send the address. Param eters returned None. Prerequisites Adapter m ust be conf igured using setu p. Functional desc ription T his f unction causes the Adapter to read a block of data via the I2C bus . 3.3.13. GetBlock Data Function spec ific ation int GetBlo[...]

  • Page 15

    CALIBRE Issue 1.0 Page 12 01/07/03 3.3.16. Block SlaveTrans mitter Status Function spec ification int Block SlaveT ransm itterStatus ( void)) Parameters are: None Parameters returned int Transf erStatus . Returns 0 if the transfer has not been com pleted. Returns the a status if the trans fer is com pleted (see below). Bit 0 Set if a write addres s[...]

  • Page 16

    CALIBRE Issue 1.0 Page 13 01/07/03 3.3.18. Block SlaveReceiverStatus Function spec ific ation int BlockSlaveReceiver Status (void)) Parameters are: None Parameters returned int Transf erStatus . Returns 0 if the no data has been received. Returns the a status if the trans fer is com pleted (see below). Bit 0 Not Used Bit 1 Not Used Bit 2 Not Used B[...]

  • Page 17

    CALIBRE Issue 1.0 Page 14 01/07/03 3.3.21. W rite_IO_Pin Function spec ification int W rite_IO_Pin (int IO Number , int IOState) Parameters are: int IONumber The num ber of the IO pin (0 or 1) to be driven int IOState The requir ed state (0 or 1) of the selec ted IO pin Parameters returned int Returns a 0 if function s ucces sful. Returns 0x800D if[...]

  • Page 18

    CALIBRE Issue 1.0 Page 15 01/07/03 3.3.23. SendAddressNoStatus Function spec ification void SendAddres sNoStatus(int SlaveAddr ess, int SetNac k, int NoT ries) Parameters are: int SlaveAddress This is the address to be access ed via the I2C, e.g. A0H. int SetNack This controls whether the Adapter tr ansm its an ack nowledge down the I 2 C bus on re[...]

  • Page 19

    CALIBRE Issue 1.0 Page 16 01/07/03 3.3.27. RestartNoStatus Function spec ification void Restar tNoStatus(int SlaveAddres s, int SetNack , int NoT ries) Parameters are: int SlaveAddress The addres s to be acces sed via the I2C, e.g. A1H. int SetNack This controls whether the Adapter tr ansm its an ack nowledge down the I 2 C bus on reception of a by[...]

  • Page 20

    CALIBRE Issue 1.0 Page 17 01/07/03 The Real- Time Bus M onit or To ins tall the monitor run the setup progr am loc ated in the CD_USBUSB_Monitor folder, follow the instruc tions given by the installation wiz ard. Before attem pting to run the m onitor program ensure that the device drivers are installed c orrectly in accordanc e with this manual.[...]

  • Page 21

    CALIBRE Issue 1.0 Page 18 01/07/03 A ppendix A I 2 C Communications A dapter Status Codes This is an eight bit register , read using the GetStatus routine. Each individual bit has its own meaning as follows: Bit 7 (MSB) - The (old) PIN Bit To all intents and purposes, this bit is now redundant. Previous Calibre I2C pr oducts used this bit to synchr[...]

  • Page 22

    CALIBRE Issue 1.0 Page 19 01/07/03 A ppendix B Migration Notes for Existing Calibre I2C Customers Thes e notes are intended fo r custom ers who have code working on one or m ore of Calibre UK’s existing AT or PCI based adapters and wish to conver t it to work with the new UCA93 Adapter. The fundam ental differ ences are a m uc h reduced relianc e[...]

  • Page 23

    CALIBRE Issue 1.0 Page 20 01/07/03 The slave functions of the UCA93 dif fer m ost f rom traditional Calibre AT and PCI bus based pr oducts. A user must m ak e a pre-deter mined dec ision whether to put the adapter into m aster, s lave transm itter or slave receiver m odes. T he adapter’s own address is es tablished as part of the Setup func tion.[...]

  • Page 24

    CALIBRE Issue 1.0 Page 21 01/07/03 W hen the mast er term inates the trans fer, the adapter c ompletes sending the data block to the host together with a single status byte indicating how the transfer went, and the data is put into a global variable. The Bloc kSlaveRec eiverStatus f unction waits for this status byte and the byte can be interpreted[...]

  • Page 25

    CALIBRE Issue 1.0 Page 22 01/07/03 When the T HE MO ST COM M ONLY AS KED I2C QUEST IONS General Que stions Question I get corrup ted transf ers why is this? Answer The m ost lik ely reason for c orrupted trans fers is either incor rect bus ter mination or exces sive capacitanc e - see the m anual for details. Question Do you have software to talk t[...]