ByVac Product Specification- Version 2 BV4102. LED 8x8 Serial Matrix. Product specification. July ByVac 2006 ByVac Page 1 of 21

Transcription

1 Prduct specificatin. July 2006 ByVac 2006 ByVac Page 1 f 21

2 ByVac Prduct Specificatin Versin 2 Cntents 1. Crrectins t this sectin Changes fr versin Intrductin eatures Cnnectin infrmatin Matrix Cmmands KM KD Reveal RR RW KW KR KG, KB, KO Character Set B Cmmands BR BG U Cmmands US UD LED Cmmand Errr Cdes Hardware Reset Revisins t the IASI Sectin Intrductin t IASI IASI Electrical Interface Serial Cnnectins actry Cnfiguratin n-inverted Mde Cmmands Addressing Cmmand rmat Cmmand Parameters Cmmand Line (Buffer) Cmmand Set The Star * Cmmn Cmmand Set (Z) Summary ZA ZB ZC vember f 21

3 24.5. ZD Z ZK ZL ZM ZR ZT ZV ZW ZZ Z Cmmand Errr Cdes Cnnecting and Cnfiguratin Recnfiguring Micrcntrller Use Simple With feedback Baud rate Multiple Devices Restring actry Defaults Sftware Hardware Watchdg Trubleshting ByVac Page 3 f 21

4 1. Crrectins t this sectin Rev Change 1.00 Preliminary 1.01 Cnnectin infrmatin added 2.00 Versin Minr changes 2. Changes fr versin 2 All versin 1 cmmands are cmpatible with versin 2 s existing sftware shuld nt be effected. The fllwing additins have been made t this versin: A character set has been added A new reveal cmmand and secndary display buffer Binary input fr the Dt cmmand A character set has been added t make hst the unit less demanding n hst sftware. The characters cnsist f ASDCII values 32 t 122 and can be displayed in red, green r bth. The new cmmands fr this are CR,CG and CB There is nw a secndary display buffer that can be pre-laded with a display map and then revealed at sme later pint in time. This applies t the Mix and Dt cmmands. r full details see thse cmmands. The Dt cmmand has been extended t accept binary input, this greatly reduces the sting length when creating displays. The frmat is reasnably cmplex but there is an accmpanying spreadsheet that makes the design f characters a simple jb. 3. Intrductin This is an LED matrix and cnsists f an 8x8 array f tri clur LED s that can be individually activated t prduce green red and when cmbined, range. The interface is greatly simplified by the use f a prprietary serial cmmunicatin system based n text cmmands. Each device can be cnfigured t have it s wn address and s mre than ne device can use the same serial line. The asynchrnus serial interface is autmatically cnfigured at start up t the sense the baud rate. The interface can be cnfigured in either interactive r nn-interactive mde. Only ne line (TX) is required if n feedback frm the device is required. 4. eatures Easy t use asynchrnus serial interface requiring nly 4 cnnectins. Cmmand set based n text Only 2 data lines required, transmit and receive. The device will wrk with transmit nly. Devices are X-Y stackable Many devices can use the same tw data lines Each device has it s wn user cnfigurable address specialist hardware, can wrk frm a PC Cm prt Autmatic Baud rate detectin up t 38.4K, nn-standard baud rates can be detected making interfacing with micrcntrllers easier Simple sftware requirement fr interfacing with a micrcntrller. Cmmn prtcl used thrughut range, devices can be mixed n same data bus ree Terminal sftware fr Windws Wrks with RS232 standard vltages and +5V, n level translatr needed fr receiving data Tri clur RED and GREE cntrlled individually, use tgether t make ORAGE RED and GREE brightness can be cntrlled. User cnfigured splash screen enables a custmised sequence f bit patterns t be displayed at switch n Variable delays can prvide a simple text based shw User cnfigurable address Six user defined bit patterns can be stred in nn-vlatile memry. 5. Cnnectin infrmatin The Matrix has a standard IASI cnnectr at the back the pin ut infrmatin is as the picture shws. ByVac Page 4 f 21

5 When this flag set t ff n this device it disables the utput. The cnsequence f this is that this device will nt be able t utput any infrmatin. As this is a display device the nly infrmatin that may be required is an ACK, hwever in practice this device is very fast and is likely t be able t wrk at the same speed as the system t which it is built. In this mde the device is therefre effectively read nly. Invert flag summary Invert lag On Off Pin 2 (TX) Output inverted data Output disabled The pins are numbered frm 1 t 5 and have the fllwing functins: 6. Matrix Cmmands Cmmand ame KM RM KD RD Mix Reveal Mix Dt Reveal Dt The IASI interface is fully described in sectin 18 but there are sme differences fr this device. This device is primarily intended as a display device and as such the feedback frm the device is limited. The cnfiguratin arrangements fr this device are different frm the ther BV devices, this nly applies t the utput frm this device (pin 2), the inputs will wrk the same as all f the ther devices. The difference is, is that the utput frm pin 2 (TX) is always inverted and cannt be uninverted using the cnfiguratin flag as can the case fr the ther devices. Because this is essentially a display (utput) device this shuld nt be a prblem. When used with RS232 There is n difference because the RS232 interface expects the utput t be inverted, the device will wrk as described in the sectins belw. This mde is the factry default and can be used t set up the device if required. When used with a Micrcntrller In this mde the invert cnfiguratin flag (see the ZC cmmand in sectin 24.4) will nrmally be set t ff because a micrcntrller sends data nn-inverted, unlike RS232 that inverts the data. RR RW KW KR KG KB KO CG CR CB BR BG US UD Reveal Buffer Wipe Reveal Buffer Wipe Red Green Bth Off Character Green Character Red Character Bth (range) Brightness red Brightness - green Set User Character Display User Character K cmmands are specific t the LED matrix and in general cntrl which LED s are n and which are ff. ByVac Page 5 f 21

6 7. KM ame: Mix Cmmand Parameters: r x Typical Use KM1 RRRG The mix cmmand is designed fr switching n 1 rw at a time. The cmmand has tw parameters, r and x. The first parameter r specifies the rw number, a number between 1 and 8 where 1 is the tp rw and 8 is the bttm rw. The next parameter is a string that must be enclsed in duble qutes. The fllwing characters are allwed within the string: R,G,B,O and the string must be at least 1 character lng but nt mre then 8 characters lng, there are nly 8 clumns s any greater number than this wuld nt make sense. The letters R,G,B,O refer t Red, Green, Bth and Off. O is the letter O nt zer. They can be in either upper r lwer case s the cmmand KM3 RRR wuld be exactly the same as KM3 rrr. The cmmand is used t turn n r ff individual LED s f the rw specified. A feature f the cmmand is that it will nt turn ff a LED that is already n s KM3 rrr fllwed by KM3 rrg will leave the first tw LED s f rw 3 red and the third LED range. This culd f curse be carried ut in ne cmmand KM3 rrb. OTE that it imprtant t leave a space between the rw number and the first pening qute. This KM3 RRRG will give an errr This LM3 RRRG is crrect 8. KD ame: Dt Cmmand Parameters: [*] string Typical Use KD rrrrrrrrgggggggg r kd*33b33d073d e3333 Text rmat This cmmand is similar t KM hwever the string start refers t the tp left crner f the display and cntinues in rws t the bttm right. The whle display can be referenced in ne 64 character string. Example: KD rrrrggggrrrrggggrrrrbbbbbbbb Hex rmat A pwerful and cmpact methd t represent a full display is t use the hex methd. By using the * ptin the full 128 LED s can be represented in 16 bytes. te these are text representatins f hex s in fact there are 32 bytes in the sting excluding the cmmand. There are 8 clumns, each clumn needs tw bytes, ne fr red and ne fr green, hence 16 bytes. T add a little further cmplicatin 1 is ff and 0 is n. R G R G R G R G R G R G R G R G # # # # # # # # # # # # # # # # B B B D 8 0 The abve is an example f the character 1 and hw it wuld be represented in hex frmat. In the first clumn there are n LED s illuminated s red and green will bth be ff. In the third clumn (red), reading dwn the clumn the value is: , which is BBh. There is a spreadsheet n the web site called Matrix designer.xls that can be used t simplify the abve prcess. 9. Reveal The principle behind reveal and the assciated cmmands, RM, RD, RR and RW is that the cmmand fills a hidden buffer. This buffer is cpied t the display buffer by the RR cmmand. Using this it is pssible t pre-lad displays and switch t them withut difficulty. It is als pssible t re-reveal after the KW cmmand thus a flashing display is easy t prduce. The reveal facility is available n the Mix and Dt cmmands and they are: B B ByVac Page 6 f 21

7 RM equivalent f KM RD equivalent f KD 9.1. RR ame: Reveal Cmmand Parameters: nne Typical Use RR This cmmand is used t reveal a previusly laded display using the RM r the RD cmmands. Example: KD rrrrrrrrgggggggg ( lad smething n the display ) rd*33b33d073d e3333 ( pre-lad abve lg, this will nt be displayed until the RR cmmand is used ) rr ( reveal lg ) In the abve example a display can be laded in the backgrund and then revealed at sme later pint in time. Als by using KW fllwed by RR, the latter cmmand will re-reveal the lg described in the abve RD* cmmand. The display will remain in the reveal buffer until either the pwer is switched ff, it is verwritten by anther display r the RW cmmand is used RW ame: Reveal Wipe Cmmand Parameters: nne Typical Use RW This cmmand is equivalent t the KW cmmand in that it will clear the reveal buffer rather than the display buffer. 10. KW ame: Wipe Cmmand Parameters: nne Typical Use KW This cmmand simply blanks the display KR ame: Red Cmmand Parameters: n[;n][-n] Typical Use KR33;2-5 This is a cmplex but very pwerful cmmand that can be used instead f, r as well as the KM cmmand. Bth can achieve the same results. The cmmand enables individual RED LED s t be switched n r ff anywhere n the display either individually r as cnsecutive blcks. The LED is specified as a number frm 1 t 64 accrding t the table. A semicln ; is used t separate the statements in the cmmand and the - is used t specify frm t Unlike the mix cmmand this will verride any ther clur already n. The cmmand is best illustrated with examples: KR20 this will turn n red LED 20, i.e. rw 3 clumn 4. KR1;9;17;25;33;41;49 This will turn n all f the red LED s in clumn 1. OTE be careful nt t exceed the input byte buffer limit, this determines the number f characters yu can get n ne line. The buffer limit varies frm device t device but is typically 80 characters. When the limit is exceeded (prvided the debug level is set) and errr 1 will be displayed. KR1-8;36;49-56 This will turn n the tp rw (1-8) the bttm rw (57-64) and an LED near the middle (36). KR1-64 This will turn n all f the red LED s. ByVac Page 7 f 21

8 The syntax is straightfrward if it is remembered that all statements are separated by a semicln ; and a statement can cnsist f either 1 number (between 1 and 64) r tw numbers separated by a -, 3-22 fr example. Think f the - as t, i.e. 3 t 22. Spaces can be used fr clarity, fr example: KR 1-8; 36; KG, KB, KO The abve cmmands are exactly the same as the KR cmmand except that they refer t green, bth and ff respectively. 11. Character Set Included in the display memry is an ASCII character set. This can be displayed in either red, green r bth red and green. The characters are a sub set f ASCII and cver the values 32 t 122. This includes symbls, numbers upper and lwer case. T display a character the ASCII value must be used alng with the cmmand. The clur f the character is determined by the cmmand: CG CR CB Example: CR49 CG104 Green characters Red characters (Bth) Orange characters Displays 1 in red Display h in green CB65,ZW10,CG66 The abve will display an range A fllwed by a green B after a shrt pause. 12. B Cmmands The brightness f either the red r green LED s can be cntrlled. This is a glbal setting and is held in EEPROM s the setting will remain when pwer is restred. The values are frm 0 (ff) t 10, full brightness BR ame: Red Brightness Cmmand Parameters: n (0-10) Typical Use BR BG ame: Green Brightness Cmmand Parameters: n (0-10) Typical Use BG4 13. U Cmmands These cmmands are used fr saving and restring a bit pattern. The technique is t create a bit pattern and than save it using the US cmmand fr later retrieval by the UD cmmand. Up t 6 patterns can be defined US ame: User character save Cmmand Parameters: n Typical Use US1 User save, this cmmand is used t save t EEPROM a bit pattern that is currently displayed. This can later be recalled by the UD cmmand. The parameter n is a number between 1 and 6, thus 6 individual patterns can be saved. The patterns will be permanently remembered until verwritten with anther bit pattern r the factry defaults are set. T save a pattern currently displayed n the screen simply type US n, where n is a number frm 1 t 6. The display will mmentarily flash, indicating that the pattern has been saved UD ame: User character display Cmmand Parameters: n Typical Use UD1 This will recall a previusly saved bit pattern. the parameter n is a number between 1 and LED Cmmand Errr Cdes Errr cdes will be displayed if the debug level is set t greater than 0. Level 1 will reprt the errr cde t the terminal and errr level 2 (bth set by the ZC cmmand) will indicate the errr number n the display by lighting up the crrespnding LED number. In ther wrds if say errr 5 ccurs and the errr level was 2 then LED number 5 wuld light up. LED 5 is specified as the fifth LED frm the tp left crner. See the abve table fr LED numbers. Cde Descriptin 11 Bad string, usually as a result f leaving ut a in the KM cmmand. 12 umber ut f range 15 n-valid rw specified, The LED has rws numbered frm 1 t 8, anything utside this will cause an errr. 16 Expecting either R,G,B r O (nt zer) in a cmmand. 17 Expecting - r ; ByVac Page 8 f 21

9 18 Expecting a number between 1 and Hardware Reset The prcedure fr hardware reset is the same as the ther devices. The nly difference is, which hles t shrt. The picture shws which are hles 1 and 5, fllw the instructins in sectin 28 (Restring factry defaults) ByVac Page 9 f 21

10 16. Revisins t the IASI Sectin Rev May 2006 June 2006 December 2006 January 2006 V1.03 Change Additinal infrmatin abut cnnecting multiple devices and hardware factry reset. Trubleshting guide added This versin is applicable t the LED matrix. Additin f Lck cmmand ZZ applicable t versin 2-b 17. Intrductin t IASI The Intelligent Asynchrnus Serial Interface (IASI) is a cmmn standard that makes it much easier t cntrl and use hardware frm either a standard cmmunicatin interface (terminal) r a micrcntrller. It is based n a very simple text cmmand set and a flexible hardware interface. The Intelligent aspect is derived frm the fact that each particular IASI knws abut the cnnected hardware s a simple cmmand can make the hardware perfrm a reasnably cmplex functin. Scrll text n an LCD display fr example. when used in a micrcntrller system this enables the cntrller and designer t cncentrate n the imprtant aspects f the design and cntrl rather than the mundane jb f cntrlling the hardware. It als means that the task f driving cmmn peripherals is nt being cnstantly re-invented. The Baud rate is autmatically detected at start up r it can be cnfigured in sftware t a fixed, default baud rate. The device detects the baud rate n receiving a CR character (0Dh). Other received characters will be ignred until the Baud rate has been established. The transmit pin has an pen cllectr utput that has a pull-up resistr n bard cnnected thrugh a jumper. Where mre than ne device is used n the same serial line, nly ne jumper shuld be shrted. See the sectin n multiple devices fr further infrmatin. 19. Serial Cnnectins The device is designed t wrk in either f tw mdes: an IVETED mde fr cnnecting directly t an RS232 prt (factry default) r a O-IVERTED mde fr cnnecting t a micrcntrller UART. As previusly described there are tw inputs, ne fr each alternative interface. On the transmit side (utput frm the interface) there is nly ne pin that takes care f inverted and nn-inverted lgic, this is cnfigured in sftware. The utput is 0 t +5V nly, rather than the RS232 specificatin requiring psitive and negative signals. On mst RS232 specificatin interfaces this will wrk althugh it is nt within the actual RS232 specificatin. 18. IASI Electrical Interface The device has very simple requirements. A pwer supply, transmit and receive lines as shwn in table E1. The interface is specifically designed s that it can be cnnected t either a standard cm prt (n a PC fr example) r directly t a micrcntrller UART r even a micrcntrller prt pin with a sftware generated UART (Universal Asynchrnus Receiver and Transmitter). A five pin cnnectr is used with nrmally nly 3 r fur pins being cnnected at any ne time. There are TWO receive lines, pin 1 receive line will accept nrmal 5V lgic as presented by a micrcntrller pin r UART and pin 4 will accept psitive an negative vltages up t 15V that are nrmally present n a standard RS232 interface. Pin 4 will als invert the lgic which is als nrmal fr this interface. ByVac Page 10 f 21

11 Mst micrcntrllers hwever perate n nninverted lgic and utput 0V fr zer and +5V fr lgic 1. T perate in this mde issue the cmmand: ZC3 r See Sectin 26 r the cmmand set fr mre infrmatin. igure 1 Cnnectin t a PC igure E1 shws the cnnectins t a 9 pin D type cnnectr fund n mst PC s. The Baud rate is autmatically determined by detecting the first Carriage return it receives r it can be cnfigured t a fixed baud rate in sftware. See the sectin n cmmands (ZC) fr further details. 20. actry Cnfiguratin When an IASIM (Intelligent Asynchrnus Serial Interface Mdule) leaves the factry it is cnfigured t autmatically detect the baud rate and interface with a standard PC cm prt. Regardless f the cnfiguratin the device will receive bth frms f electrical interface (inverted and nn-inverted) depending n which pin is used. S even if it may nt be pssible t see the utput frm the device, it will nrmally accept the input. The transmit is cnfigured by sftware and this is cnfigured t invert. The interface des nt need this pin t be cnnected t receive cmmands. actry settings can be restred bth in sftware and hardware. The cmmand Z (see later) will restre the factry cnfiguratin. T restre factry defaults using hardware see Appendix A 21. n-inverted Mde As previusly mentined the device is capable f perating with a standard RS232 cmmunicatin prt and this is the factry default and is useful fr cnfiguring and learning the device capabilities. 22. Cmmands The interface is cmpletely sftware driven, all cmmands and cnfiguratin are dne thrugh a serial interface. The nly exceptin t this is the hardware factry default restre, see Sectin 28. A very simple cmmand prtcl is used that essentially perates in tw mdes. An interactive mde and an addressing mde. The general frmat f the cmmand is: Interactive <cmmand><cmmand-parameters><cr r,> e.g. ZA Addressing :<address><cmmand><cmmandparameters><cr r,> e.g. :00ZA The purpse f the interactive mde is t enable the user t learn the device capabilities and als t be used in a system where nly ne device is cnnected t the bus. This is the default prtcl the prmpt fr this is: L> The L indicates that the device is in Listen mde and will react t any cmmand given and als prduce errr messages if nn-existent cmmands are given. An alternative prtcl is available that allws multiple devices t be cnnected t the same serial bus. This is cnfigured using the ZC cmmand (see later). In nn-listen mde the prmpt is: Pin ame Descriptin 1 RX Receive data in nn-inverted frm at +5V lgic levels. Use this pin fr cnnecting t MAX232 devices r directly t micrcntrllers. 2 TX Transmit (utput) data. This is 0V and +5V, RS232 levels are nt used. Devices will wrk withut this cnnected but n feedback can be received. This pin is cnfigurable in sftware t transmit either nrmal r inverted lgic. (see multiple devices sectin 27.4) 3 +5V Standard 5V pwer t the device 4 RX-Invert Receive data (input) this will accept -12V t +15V vlts in inverted lgic as is nrmally available n a PC Cm prt. The frmat is RS232 1 start bit 8 data bits and 2 stp bits. 5 GD Grund Table E1 Serial Cnnectin Details ByVac Page 11 f 21

12 :> This indicates that a cln and address is required. In this mde the device will nly accept cmmands with its wn address and ignre everything else. In this mde the previus ZA cmmand wuld be: :00ZA Assuming that the device address is 00. te that all addresses must be preceded by a cln. The prmpt can be turned ff by the ZC cmmand Addressing All devices have a tw character address, this enables several devices t be cnnected t the same serial lines. The address can be any tw ASCII characters and it is case sensitive. Typical examples are L1 AA 25, etc. nte that aa will be a different address t AA. There is a special address 00 (zer, zer) that all devices will listen t regardless f their wn address. There is nthing t stp mre than ne device having the same address, this can be useful if bth devices always require the same cmmands. As mentined earlier if the device has been set t interactive mde and address is nt required Cmmand rmat The cmmand is a tw character string ZA fr example and is nt case sensitive, s zc wuld be the same as ZC. All cmmands have tw characters and in general the first character is a class f cmmand and the fllwing letter is a subclass f that cmmand. All cmmands beginning with Z are cmmn t all devices and usually deal with cnfiguratin and cmmunicatin. Other tw letter cmmands deal with the device direct and the same cmmands may mean different things fr different devices Cmmand Parameters The cmmand parameters can be anything and are specific t that cmmand. In mst circumstances spaces are ignred and can be used freely. Spaces d hwever serve t separate parameters (space is the delimiter) where mre than ne is required. r example given the cmmand belw that is used n the LCD IASM L>WT3 Hell The 3 requires a space after it s that the number can be distinguished frm the text. In general thugh spaces are ignred and can be used freely Cmmand Line (Buffer) All cmmands strings are buffered in a 64 byte buffer and devices will stre any text received n the bus. Any lines greater than 64 characters will be ignred and generate an errr s it is imprtant nt t exceed this figure n an autmatic system. Prviding the debug level is set t greater than zer (see ZD cmmand) then this will be reprted as an errr. When a Carriage Return (ASCII 0dh) is received (cnfigurable) the text string is passed t the cmmand prcessr. In nn-listen mde nly devices with a matching address will respnd, tw r mre devices can have the same address if required. The line end character is set at the factry t be 13 (0dh) and this can be changed using the ZL cmmand. Sme systems send nly this thers send a Line eed (10, 0ah) and thers send bth, either way rund. The IASI will nly accept the cnfigured value and ignre r skip ver anything else. A cmma (,) can be used t allw mre than ne cmmand in a single line. This is especially useful in nn-listen (address) mde as the device nly needs addressing nce: :>:00ZAL2 :>:L2ZD1 r :>:00ZD1 can be sent as: :>:00ZAL2,ZD1 (prmpt) (cmmand) The abve will set the device address t L2 and the debug level t Cmmand Set Cmmand sets cnsist f a tw character cmmand. The first character usually refers t the general type and the secnd later is specific t that cmmand. The Z cmmand set fr example is the cmmn cmmand set fr all devices. The Z cmmands cnfigure the device interface and cmmunicatins The Star * As a general rule mst cmmands issued n their wn will return their value in printable frmat fr example ZD will return the current debug level 0,1 r 2. This will be printed n the terminal screen. In abslute terms the values returned are in fact the values 30h, 31h r 32h which crrespnd t the printable values 1,2 r 3 (the ASCII cdes fr these characters). When used with a micrcntrller fr example it may be mre cnvenient t knw the actual ByVac Page 12 f 21

13 BIARY value. By using a * this will return the actual value thus. ZD* The abve will return the actual binary value 1,2 r 3 which will nt be printable n the terminal screen. This may be particularly imprtant fr numbers greater than 9 as the printed versin f 10 is in fact 1 (31h) and 0 (30h), tw bytes. Whereas the actual value 10 is nly ne byte and much easier t handle. 24. Cmmn Cmmand Set (Z) A summary f the cmplete cmmn cmmand set is given in the table. All cmmn cmmands begin with Z, as previusly mentined cmmands are gruped by the first letter s any cmmand beginning with a Z is a cmmn cmmand. A full descriptin f each cmmand is given after the summary Summary Cmmand ZA ZB ZC ZD Z ZK ZL ZM ZR ZT ZV ZW ZZ Descriptin Address Baud Rate Device cnfiguratin Debug level actry reset Ack character Line end character Recrd Macr Reset Test macr Versin Wait Lck te that any example given will assume that the device is in interactive mde (listen flag n) s n address is required t precede it ZA ame: Address Cmmand Parameters: [*address] Typical use :00ZA r ZA (listen n) This cmmand will shw, cnfirm r set the address. T see the address f the current device simply use the cmmand withut any parameters: ZA This will return the actual address f the device, this will be 00 after factry reset. ZAK1 This will set a new address fr the device, K1. Addresses cnsist f tw characters (including numbers) and are case sensitive s setting the address t AA will be different frm aa. :K1ZA*K1 This cmmand is used fr cnfirming that a device is n the bus and wrking kay. In the abve if device K1 is n the bus it will respnd with ACK (see the ZK cmmand fr ACK). The single ACK character is usually easier t detect by a micrcntrller than the tw byte address returned withut the * parameter ZB ame: Baud rate Cmmand Parameters: [*][rate] Typical use :00ZB r ZB (listen n) At factry default the Baud rate is detected by receiving a carriage return character (CR value 13, 0dh) frm the sending device. A minimum f tw are required, ne fr the detectin and the ther fr cnfirmatin. The quality and length f the serial bus may als effect the detectin prcess. The detectin will chses frm a fixed set f baud rates: This has been fund t be very reliable depending n the quality f the electrical interface. The cmmand enables viewing and setting f any f the abve values 0-5 that crrespnd t the Baud rate. If the Baud Detect flag (see the ZC cmmand) is set t ff () then the Baud rate will be determined by whatever this cmmand is set t. As an example if ZB is set t 3 and Baud detect is ff, the device will cmmunicate at Baud when switched n. If ZB is set t 3 and Baud detect is ff then the Baud rate will be determined by the first acceptable Carriage Return character received. ZB Baud Detect Baud Rate 3 Off On Set by receiving CR ByVac Page 13 f 21

14 character frm hst device. The Baud rate can als be reprted in binary, in the abve example: BR will return 3 (ASCII value 33h) BR* will return the value 3 which will nt be a printable character, this is useful fr micrcntrller input, see the sectin n the star cmmand extensin ZC ame: Cnfigure Cmmand Parameters: n [*][-w aaaaaaa][-r] Typical Use :00ZC3 -r This is prbably the mst cmplex cmmand but will alter the way the device behaves and is nly likely t be seldm used. There are 7 flags that will effect the device and these are: 1. ACK 2. Macr 3. Baud detect 4. Invert *** 5. Listen 6. Prmpt 7. Ech The abve flags can either be n r ff (Y r ) and they have the fllwing meaning: ACK When the line end character (ZL cmmand) is received by the device there is an ptin t send the ACK character (ZK cmmand). If this is set t n (Y) then the ACK character will be sent. See the ZK cmmand fr details n why yu wuld want t d this. Macr When the device is first pwered n, ptinally a set f cmmands can be run, see the ZM, ZT cmmands. If this flag is set t Y then the macr cmmands will be run at start up. Baud detect The device can perate at a fixed Baud rate r detect the hst Baud rate at start up. When this is set t Y the device will wait fr input frm the cntrller Terminal t determine the Baud rate, see the ZB cmmand) Invert *** This nly applies t the transmit line f the device. When set t Y all transmitted data will be inverted, this is suitable fr cnnectin t nrmal RS232 type interfaces, a PC cm prt fr example. This device will OLY utput inverted data. When set t n, fr cnnectin t a UART the utput frm this line is disabled. Listen If this is set t Y a cmmand will be accepted withut addressing, this is useful fr single devices cnnected t the bus and saves having t prefix all cmmands with cln, address. Prmpt When set t Y will utput n the transmit line a prmpt. This is useful fr experimenting with the device when using a standard terminal. There are tw types f prmpt depending n hw the listen flag is set, see the sectin n addressing. Ech When this is set t Y all characters received will be transmitted t the transmit line. It is nt advisable t have this n when used with autmated systems. It may als slw dwn the cmmand receptin prcess. The technique fr setting these cnsists f string a cnfiguratin in nn-vlatile memry and then restring this cnfiguratin later. There are eight cnfiguratin lcatins that can all be used. When restring factry defaults the first 6 lcatins are verwritten with the values shwn in the table. T bserve a cnfiguratin use: ZCn r ZCn* where n is a number between 0 and 8 using ZCn withut a * will prduce a sting f Y and. As an example: ZC0 will prduce YYYY given the factry defaults. ZC0* will return 1Eh which will nt be printable using a Terminal but will be mre understandable t a micrcntrller. T change a cnfiguratin w is used t indicate write. As an example t set a new cnfiguratin in slt 6 the fllwing cmmand can be issued: ZC6 w YYYY ByVac Page 14 f 21

15 Cnfig Byte Ack Macr Baud-d Invert Listen Prmpt Ech 0 1E n n y y y y n Inv-interact 1 14 n n y n y n n run-single 2 4 n n n n y n n run-single 3 10 n n y n n n n run-multi 4 Undefined 5 Undefined This will write a new cnfiguratin t slt 6 having the same values as the factry default, cnfiguratin 0. Any slt (cnfiguratin) can be verwritten at any time but using the Z cmmand, factry defaults, will reset the first 6 cnfiguratins t that in the abve table. T set the device t a cnfiguratin r is used (read), s: ZC0 r will set the device t cnfiguratin 0. OTES The purpse f the 5 cnfiguratin slts are t enable quick changing f device cnfiguratin. In mst cases ne f the default cnfiguratins will suffice and s the user may nt be cncerned with the individual aspects f each flag. The first 3 (0-2) cnfiguratins are intended fr using n PC terminals that have an inverted lgic. The next three are intended fr use with a micrcntrller utput that des nt have an inverted lgic. There is nthing t stp the user frm specifying illgical cnfiguratins r even using a slt that has nt been previusly cnfigured. This can make the device very difficult t cmmunicate with. If this shuld happen than a hard reset will prbably be required, this is described in Sectin 28. OTE The use f this cmmand with r r - w will cause the device t reset, similar t using the ZR cmmand ZD ame: Debug Cmmand Parameters: [*][n] Typical Use :00ZD0 There are three debug levels available. level 0 will nt reprt any errrs at all. This is used where multiple devices are n the same bus and the errr reprting may interrupt nrmal cmmand flw. Level 1 will reprt t the nrmal transmit line and level 2 will reprt t the device if this is pssible, LCD displays fr example. te if the device is nt capable f displaying the errr then level 2 will be equivalent t level 0. As in the previus cmmands ZD n its wn will reprt t the terminal in ASCII frm and ZD* will reprt in binary frm. A new level can be set by fllwing the cmmand with the new level, e.g. ZD1 set debug t level Z ame: Reset t actry Defaults Cmmand Parameters: nne Typical Use Z This will set the device t the factry default cnfiguratin, see sectin 28 fr what this is. Prviding there is cmmunicatin with the device this cmmand can be useful fr establishing a knwn cnfiguratin autmatically. r example: Z CR (carriage return) CR :00Z CR CR Shuld set the factry defaults even if the device is in interactive mde r nt. This can then be fllwed by a desired cnfiguratin, ZC3 r fr example ZK ame: ACK (acknwledge) Cmmand Parameters: [*][n] Typical Use ZK6 When a line end (CR) is sent t the device the cntents f the buffer are interpreted fr a cmmand and then acted upn. This takes a finite time t cmplete. In an autmated system a delay can be used t allw fr this. Hwever the delay must be set fr the lngest time t ensure that all cmmands can be dealt with. Optinally (see the ZC cmmand) an acknwledge (ACK) mechanism can be switched n. If this mechanism is switched n, when the cmmand has cmpleted an ACK will be sent t indicate t the cntrller that anther line is ready t be accepted. This frms a simple but reliable handshake methd that can be used fr sending text files t a device r fr using autmated devices. The ACK character can be set r displayed using this cmmand. ByVac Page 15 f 21

16 ZK displays the character represented as a decimal printable number, ZK* will return the ACK character as a binary value and ZK6 will set the ACK character t the factry default value f ZL ame: Line end character Cmmand Parameters: [*][n] Typical Use ZL13 The line end character (EOL) is imprtant as it infrms the IASI t interpret the cntents f the buffer. Unfrtunately this character is nt in universal use, sme systems send 13, ther send 10 and thers send a cmbinatin f bth which can be either way rund. The ZL cmmand allws the specificatin f the character that will mark the end f line. This als gives the pprtunity fr any special requirements, e.g. 0 can be specified. Examples: ZL returns the value as a decimal number in text frm. ZL* returns the value in binary frm (1 byte) ZL2 sets the end f line character t 2. WARIG if yu d this yu will nt be able t cmmunicate with the device unless yu end the cmmand line with <CTRL>B (02) OTE: The system will ignre r skip ver any received values that are belw a value f 32 (20h) except the fllwing characters: Escape Back space ZL character 17, 1bh (interpreted as EOL) 8, 8h ZM ame: Macr 13, 0dh (by default) Cmmand Parameters: nne Typical Use ZM <see belw> A macr is a cmmn cmputer term t allw a sequence f cmmands t be recrded and played back at a later time. This cmmand allws just that. The playback is nrmally at start up and allws prgramming f lgs etc. n apprpriate devices. The cmmand is used n its wn; enter the cmmand ZM and the fllwing prmpt appears: 175> The number 175 (differing devices may have a different number) in frnt f the prmpt shws the space available in characters. This will reduce as cmmands are entered. Any valid cmmands can be used but the syntax is nt checked until run time, the macr sequence can be checked with ZT. T exit this cmmand use Escape. Macrs cannt be edited, the nly way is t enter them frm the beginning again. They can f curse be sent as a text file frm a terminal. te that if the macr flag is set, see the ZC cmmand, the cmmands will be run at start up s care shuld be taken what cmmands are entered. The factry defaults will nt change the cmmands yu have entered but it will set the macr flag t 0 s the macr will nt run at start up. A brand new device has the macr flag set t 1 s it may be wrth while setting this t 0 befre experimenting. See the ZC cmmand n hw t d this. The macr can be tested suing the ZT cmmand ZR ame: Reset Cmmand Parameters: nne. Typical use ZR This is the reset cmmand and will reset the hardware and put the cmmunicatin mde as if it had just been switched n ZT ame: Test Macr Cmmand Parameters: nne Typical Use :00ZT This will test any stred macr and shuld be used befre setting the macr flag ZV ame: Versin infrmatin Cmmand Parameters: nne Typical Use ZV This simply returns a sting that cntains the firmware and device versin infrmatin. Additinal infrmatin is als displayed but this des nt apply t all devices: The ZV cmmand is als used fr detecting errrs and indicating if the factry defaults have been set. The frmat is: [Wnn] <versin infrmatin> Where n is either 0 r 1. Under nrmal circumstances this wuld read [W00]. r infrmatin abut this see the separate headings under watchdg and factry reset. OTE that reading the data clears it s if the first read was: ByVac Page 16 f 21

17 [W10] <versin infrmatin> The secnd call f this cmmand wuld read: [W00] <versin infrmatin> ZW ame: Wait Cmmand Parameters: n ( ) Typical Use ZW110 This cmmand will simply suspend the device fr a length f time. The time is entered in apprximately 10ms intervals, s 100 is 1000 ms which is 1 secnd. A typical use is t hld back a text file when dwnlading r in a macr s that animated displays r actins can be implemented. At any time during the delay if a character is received the delay will abrt. This cmmand is nt suitable fr highly accurate delays as the 10ms interval may vary, particularly frm device t device. Example: ZW 200 The abve example will delay apprximately 2 secnds ZZ ame: Device Lck / Unlck Cmmand Parameters: see text Typical Use ZZ:00L26246:00 This cmmand is used fr cntrlling writing t the EEPROM. The EEPROM cntains imprtant cnfiguratin infrmatin and it may be pssible t inadvertently change this by glitches r writing t the device t fast fr it t cpe with and thus interpreting a valid cnfiguratin cmmand where nne exists. In applicatins where a device has been built in it may be difficult t re-cnfigure and s it is imprtant that the intended cnfiguratin remains the same. This cmmand is used fr lcking ut writes t EEPROM that will effectively stp any cnfiguratins changes. In additin t this it will prevent the Z (factry reset) cmmand frm wrking. The hardware reset will still wrk thugh. Lcking the EEPROM ZZ:<device address>l26246:<device address> Example: ZZ:D1L26246:D1 The cmmand has three parameters, the device address, the lck cmmand and the device address again. The device address must be prceeded by a cln (:), in the abve example the address is D1 (set previusly by the ZA cmmand). The lck cmmand is L The L is case sensitive and the number must be exact. The cmmand can als be used in nn-listening mde, in which case the example wuld be: :D1ZZ:D1L26246:D1 An address f 00 can als be used and this will lck all devices n the bus. Unlcking the EEPROM There are tw methds f unlcking the EEPROM, using the hardware reset and using the ZZ, unlck cmmand: Example ZZ:00U34406:00 The abve example will unlck any listening device. The cmplexity f the cmmand reduces any risk f this being prduced by a spurius sftware cmbinatin f cmmands. 25. Z Cmmand Errr Cdes Errr cdes will be displayed if the debug level (ZD) is set t greater than 0. Cde Descriptin 1 End f input buffer reached, buffer full. If this happens the whle f the input line will be ignred. 2 Unknwn cmmand, the cmmand issued is nt in the cmmand table fr this device. 4 n-valid hex, where a cmmand is expecting a hex value and smething is entered utside 0-9, a-f, A-. OTE This is rarely used as mst numbers values are in decimal. 5 Incrrect parameter fllwing cmmand. This refers t cmmands that expect a particular value t fllw. This errr will indicate that a cmmand has been entered that is nt in the crrect / expected frmat. 6 Bad decimal number. This is because the cmmand is expecting a number and smething else has been entered. te that a space shuld always fllw a number. 30 Device is lcked, attempted t write t EEPROM 31 Address mismatch when using the ZZ cmmand ByVac Page 17 f 21

18 26. Cnnecting and Cnfiguratin igure 2 Cnnectin wiring The abve wiring diagram shws the cnnectins t a standard PC 9 way cm prt (RS232 cnnectr). Pin 1 f the IASI has n cnnectin as this is used t cnnect t a micrcntrller UART. The factry defaults will wrk with the abve cnfiguratin. Start HyperTerminal r sme ther terminal sftware, BV Terminal is ideal and can be btained frm Errr! Reference surce nt fund.the fllwing settings shuld be used: Baud rate 9600 Start bits 1 Stp bits 2 Handshake nne Lcal ech n (The Baud rate is nt that imprtant as the IASI will adjust t the terminals Baud rate) Pwer up the device and press return a few times making sure that the terminal is active (muse cursr in the terminal windw). The device shuld respnd with: L> when it is ready t accept cmmands. If this is nt the case check the pwer supply and terminal settings. The device is nw ready t accept cmmands, try za. This will return 00 which is the default device address. After this prmpt the device is nw ready t be cnfigured but it may be wrthwhile spending sme time lking at the cmmand ptins available Recnfiguring It may be that yu want t use the device thrugh a line driver device (MAX232) r micrprcessr UART withut bthering with the PC cm prt cable. This is als pssible. igure 3 Using nn-inverted The abve illustrates the cnnectins used fr, in this example a BV201 bard that simply translates the PC cm prt t nn-inverted 5V lgic levels. Using a BV101 a USB slutin culd be prvided and there wuld be n need fr a separate pwer supply. See fr these prducts. Start up HyperTerminal r BV Terminal as befre and press enter tw r three times. In this instance the terminal will nt shw the prmpt as the utput is the wrng plarity, simply ignre any characters returned and type: ZC3 r w press return tw r three times t establish the Baud rate and the L> prmpt shuld appear. This illustrates that it is nt necessary t receive anything frm the device in rder t recnfigure it. The cmmand ZC3 r, lads cnfiguratin slt 3 int the device. See the ZC cmmand fr standard cnfiguratins. 27. Micrcntrller Use Simple There are several ways the device can be used with a micrcntrller. The simplest way is t use it in the default mde: ZC0 r (inverted) ZC3 r (nn-inverted mst likely) r an utput device, and LCD fr example n return value is necessary but sufficient time shuld be given fr the cmmand and device t perate. The TX line (frm the IASI) des nt even need t be cnnected With feedback A mre sphisticated methd wuld be t have sme feedback frm the device. There is als n need fr a prmpt. ByVac Page 18 f 21

19 The table shws a cnfiguratin that will d this fr a single device. T place this is say, slt 6 requires the fllwing cmmand: ZC6 w YYY T lad this int the device type: ZC6 r and issue tw r three CR t establish the Baud rate. ACK Macr Baud-d Invert Y Y Multiple Devices In the abve examples the cnfiguratin assumed that nly a single device was cnnected t the serial bus and s n addressing was required, cmmands such as ZA and ZL wuld be readily accepted by the device (called listen mde). If mre than ne device is cnnected then, unless bth are nt required t respnd t the same cmmand, each device needs its wn address. ur (three if n feedback is required) cnnectins are required. The diagram shws tw devices but mre devices can be added. Listen Prmpt Ech Y IASI 1 Jumper x IASI -2 Jumper As described in the ACK sectin f the ZC cmmand the purpse f this is t tell the master cntrller (micrcntrller) that anther cmmand can be issued. This can greatly speed up the transfer prcess Baud rate It may be cnvenient t fix a Baud rate rather than having t establish it each time by sending CR. Tw things need t be dne fr this: ACK Macr Baud-d Invert Listen Prmpt Ech Y Y irst set the desired baud rate accrding t the table illustrated in the ZB cmmand. As an example, t set the baud rate t d this: ZB3 w cnfigure the device s that the autmatic Baud rate detectin is switched ff as in the table abve. The summary f cmmands wuld be as fllws: ZB3 ZC6 w YYY CR ( carriage return) CR The device will retain the abve cnfiguratin until either recnfigured r the factry defaults have been reset. 3 Cnnect +5V tgether 5 Cnnect Grund tgether 1 Cnnect RX tgether 2 Cnnect TX tgether te: the electrical interface is designed t accept multiple devices n the RX side fr either input frm RS232 (inverted) r UART (nninverted). The TX side hwever will nly transmit t multiple UART devices in nn-invert mde. Jumper: remve all f the jumpers except ne ZAD1 Will set the device t address D1 (nte that d1, lwer case wuld be different). It is als a gd idea t stp errr messages: ZD0 inally cnfigure the device t stp listening and n prmpt. ACK Macr Baud-d Invert Listen Prmpt Ech Y T illustrate this as a series f cmmands the fllwing wuld be required. Using slt 7 t hld the cnfiguratin data. ZAD1 ZD0 ByVac Page 19 f 21

20 ZC7 w ynnnnnn CR (carriage return) CR The device can nw be cmmanded as fllws: :D1za This will return 3 bytes D 1 and 6 (if using the default ACK. 28. Restring actry Defaults actry defaults can be restred either by sftware r hardware. The factry default cnditin is: ZA00 ( address 00) ZC cnfiguratin 0 (see the ZC cmmand) ZK6 ZL13 ( ack character) ( end f line character) ZB0 ( baud rate 9600 ) ** ** te that the Baud rate will be ignred as the default Baud detect, set by cnfiguratin slt 0 is set t n. The first 6 cnfiguratin slts will be set as the table given in the ZC cmmand. Any user infrmatin placed in thse slts will be verwritten. Applicable nly t sme devices: Where a factry reset has ccurred fr whatever reasn the ZV cmmand will indicate this. A typical read ut wuld be: [W01] <versin infrmatin> The 1 in the square brackets indicates that a factry reset has taken place, this data is stred in EEPROM s even if the device is switched ff the data still remains. The act f reading the data using the ZV cmmand will clear the 1 back t 0, s this can nly bee seen nce per factry reset Sftware T set the abve cnditin in sftware use the Z cmmand, nce the Z cmmand has been issued the device will reset and wait fr at least tw CR (carriage returns) frm the hst device Hardware It is unlikely that this will ever be used but has been prvided in the unlikely event that a cmbinatin f cnfiguratins has rendered the device unable t cmmunicate. The technique is t pwer dwn the device, temprarily cnnect tw designated pints n the device tgether and then pwer up the device. The device will then be restred t its factry settings. It will require a shrt piece f wire and the tw pints will vary frm device t device. igure 4 Shrting link 29. Watchdg *** t applicable t all devices *** Sme devices have additinal errr prtectin in the frm f a watchdg timer. The timer is set internally and is cnstantly kept up t date by the firmware. Shuld anything unfreseen g wrng and the firmware is unable t update the timer a reset will ccur. The mst likely scenari fr this happening is if the serial interface is verwhelmed by input that the built in verrun prtectin cannt cpe with. If a watchdg time ut ccurs, a flag is written t the EEPROM. This can be read using the ZV cmmand: [W10] <versin infrmatin> The utput frm the ZV cmmand will indicate that a watchdg time ut has ccurred by a 1 fllwing W in the example abve. The act f reading the infrmatin will clear the flag, s the next read using ZV will shw: [W00] <versin infrmatin> Use this infrmatin t debug the external driving sftware. 30. Trubleshting The device des nt shw an L>prmpt anymre and des nt appear t respnd t any cmmands. The IASI device has a very cmprehensive set f input ptins and it is quite pssible t set a cmbinatin f input ptins that are nt cmpatible with what is cnnected. It will appear that the device has stpped wrking when in fact it is simply perating in a different mde. What s required is t get back t the factry default and take it frm there. T d this fllw the methds used in sectin 28 Restring actry Defaults ByVac Page 20 f 21

21 te that any factry macr which displays a start up sequence, the "ByVac" in the case f the LCD display fr example will nt be displayed. This is because the default setting is t turn the macr run ff, this is a safety feature in case there is sme errneus cde in the macr which prevents the display frm starting. ByVac Page 21 f 21