User's guide VIPpanel - M.J.Butcher Consulting
Contents
1. 110 1111111 0 0 0 0 Length Byte No 31 0 not addressed Value ID6 IDO 3 Bytes 1 30 29 28 27 26 25 24 The protocol allows the combination of multiple blocks from 1 4 bytes in length and also the first 7 bits IDs 0 7 in order to achieve an optimal combination of flexibility and efficiency This means that front panels with only a small number of LEDs outputs are efficient but larger designs also easily possible After the completion of the operation the VIPpanel sends an ACK In case the message format is not valid the VIP panel returns a NACK and the command is ignored Unavailable outputs are ignored but no NACK is returned in this case You can find a complete working example of a C code implementation fort he control of LEDs in the demo project Using the N command the intensity of the LEDs can be controlled After a reset this is set to a maximul level which means that active LEDs have maximul intensity The VIPpanel confirms the operation with an ACK If the intensity control ciruit is not available in the hardware or the format of the telegram is invalid the VIP panel returns a NACK Example 1 N Ox7f OxOd Sets the intensity to 5096 Example 2 N Oxbf OxOd Sets the intensity to 75 VIPpanel User s manual V1 1 12 8 2005 27 35 www mjbc ch ane M J Butcher Consultin VIP User s manual g solution eng2. Options Command according to protocol Date in hex Check sum siyed by the ViPpanel D 1c 05 9a D ic 06 93 D ic 07 98 ACK 6c 8d ACK 6d 8c ACK 6e 8b D 01 08 b2 gt c0 09 e3 S 80 Shift Mode Oa bf ACK 6 8a ACK 70 89 S 80 1234567890abcdef Ub bf 5 cO KLMNOPORSTUVWEYZ Oc b8 ACK 171 88 D 1c 1b 0d 92 El D ic 0e 91 ACK 72 87 EMI D 01 O0f ab 5 cO 10 dc 5 80 Shift Mode 11 b8 ACK 73 86 Counter End character OxOd ACK character 0x06 A ssages sent by the Vippanel CK 05 F4 ACK 06 3 ACK 07 2 k 01 6c 27 k 00 6d 27 k 02 6e 24 ACK 08 F1 k OO 6 25 ACK 09 F0 ACK 0a ef k 01 70 23 k 00 71 23 ACK b fee ACK 0c ed ACK Hm oa ec Escape Sequence The left side of the window shows all telegrams from the application to the ViPpanel The right side shows the corresponding telegrams from the VIPpanel to the application ASCII values which can not be displayed are shows as hexadecimal value in brackets Message counters and check sums are only displayed when the operating mode uses them Complete details about the protocol are given in appendix A Format of the Telegrams VIP panel User s manual V1 1 12 8 2005 13 35 www mjbc ch M J Butcher Consultin VIP User s manual g solution engineering Trace window A trace windows with debugging messages can be activated using
3. The VIPpanel sends an ACK back once the command has been processed In case the LCD doesn t pocess the capability to control the backlight intensity a 0x00 switched the back light off and any value from 0x01 to Oxff turns it on The value 0x00 off is set after a reset which means that the back ground light is default off Should the LCD have no background light this command will result in a NACK being returned This command sets the display contrast VIPpanel User s manual V1 1 12 8 2005 24 35 www mjbc ch JETER M J Butcher Consultin VIP User s manual g solution engineering Example 1 C 0x00 0x0d Sets the minimum contrast level the characters will be invisible Example 2 C Oxff OxOd oets the maximum contrast level the characters and their background pixels will be dark Example 3 C Oxb7 OxOd Sets the contrast level to 72 of maximum generally a value in this range will result in an optimum contrast setting The VIPpanel sends a c presently saved contrast setting answer once this command has been processed Should the LCD not possess controllable contrast circuitry this command will not be recognised and a NACK will be returned In order to save a contrast value the value 0x55 can be sent with the command C Oxb7 0x55 0x0d In this case the contrast setting Oxb7 will be saved as optimum contrast setting and automatically loaded as default The VIP panel returns the c answer once the comm
4. User s manual g solution engineering sum is calculated according to CCITT CRC 16 and includes all commands and data without the end character and without additional ESC characters Example of an ACK with CRC 16 check sum 0x06 0x60 OxC6 OxOd Note The VIPpanel transmits the confirmation m to this command in the modus in which it was in as it received the M command OxOd End character The VIPpanel responds to the M command with a m confirmation It is possible that the VIPpanel suggests a different mode to that requested by the M command The application must accept the mode as suggested by the VIP panel in the m confirmation The VIPpanel transmits the m confirmation in the old mode and remains in this old mode until the application completes the sequence by accepting it with the A command The application must already send the A command in the new mode of operation for it to be accepted As soon as the A telegram has been received the new mode becomes valid and the VIPpanel sends a final ACK in the new operating mode Example Application VIPpanel Application demands event mode with a check sum and a message counter M 0x1b 0x0d OxOd VIPpanel checks whether it supports this mode and answers with the m confirmation m 0x1b OxOd 0x0d The VIPpanel returns the confirmation in the previous mode The application verifies the answer and either accep
5. View Trace The information can aid in resolving problems with the VIPpanel and also problems caused by your own application The trace messages can optionally be saved to a file by activating it in the menu View Options LCD Control Panel The LCD Control Panel is a further very comfortable tool to help creating your own applications It can be activated in the menu View LCD Control panel When the LCD Control Panel is running the LCD can be controlled directly Built into the LCD Control Panel is a guide to the LCD command set and a viewer of the present LCD font set This allows you to concentrate on preparing your application without the need to consult data sheets Using the LCD Control Panel you can experiment with the capabilities of the LCD display without needing to first make a special application to do this This allows all necessary command sequences first to be evaluated before they are committed to code Use the LCD Control Panel in conjunction with the RX TX monitor to get to know the command protocol and the LCD reaction LCD Control Panel x Text Input Hex xU1 Delete LCD i LCD Visihl Hello World send mae Cursor Display commands in Hex comma separated Display Test Show cursor 01 02 Send n Reset Blinking LCD LEDs Contrast Shit direction Define characters m al Shift on 0 Columns 4 Assign character to T Ca following cade Right to lett e Frare f Left
6. mjbc ch d ll janel User s manual M J Butcher Consulting LLL solion engineering Normal connection The existing connection is not disturbed but the requester may demand the link by using the F force connection command or else later see whether the connection becomes free F 0x00 OxOd Set link to normal connection Other requestors can then force a new connection F 0x01 OxOd Set link to Supervisor connection Other requestors can then not take over the link oupervisor connection The existing link will not be distrurbed The connection can not be taken over but may become free in the future Unknown connections not allowed Only the configured Partner IP address is allowed to communicate with the front panel The connection will never become free An invalid attempt to take over a connection will receive a NACK whereas a successful attempt will be acknowledged with an ACK Keep alive When a link is connected in the Supervisor state it is blocks all other user attempts to connect This state exists until either the supervisor releases the connection setting its connection state to a normal connection or until the Supervisor connection times out default 5 minutes and sets itself automatically to a normal connection Should the Supervisor user require that the Supervisor connection exist for a longer period of time it can request the Supervisor connection again before it has timed out which restarts the tim
7. objects in the design F4 and press and hold the SHIFT button Click once on the LED to be moved to lock it to the mouse Move it to its new position and click again to lock it to the new position Note All objects in the design including LEDs can be displayed by using command Show Objects F4 in the Edit menu The objects can be hidden by using the command Hide objects F5 in the Edit menu Adding an LCD To add an LCD display to the design simply select a type from the LCD menu and position it to the required location The available LCDs can be found in the folder VIPdesigns LCDs and have the extension LCD Please contact us if you require types from additional manufacturers Saving your new design When you are satisfied with your VIPpanel design you can save it using either File Save Design or File Save design as to a VIP file This file can then be shared or exchanged with other VIPpanel users Send your design to us if you require an offer for the delivery of corresponding hardware In addition this design file is required if you would like to control the VIPpanel either over the serial interface or Ethernet LAN interface from your embedded hardware in this case we will send you a specially configured program with out charge for this use VIP panel User s manual V1 1 12 8 2005 11 35 www mjbc ch Jane M J Butcher Consultin VIP User s manual g solution engineering Setting the communication paramet
8. outputs with the IDs 1 3 and 5 to the logical 0 state The other outputs are not modified The requirement for this spcial treatment if that the MSB of the value must be 0 Special treatment of the output IDs 0 6 L 0x55 0x80 1 01 0 not addressed Value ID6 IDO Generally the outputs are grouped in to bytes and can be addressed in blocks as shown in the following examples Example 2 L 0xa2 0x55 0x55 0x0d Sets the outputs with IDs 8 10 12 14 16 18 20 22 to logical 1 and the outputs with IDs 9 11 13 15 17 19 21 23 to logical O L 0xa2 0x55 0x55 0x80 0 1 D23 gt 1 addressed Length Byte No 2 2 Byte 27 When the MSB is set the first byte serves as an address The next two bits define the length of the data from 1 to 4 bytes and the last 5 bits in the byte define the block address Example 3 L Oxdf Oxff Oxff Ox7f 0x00 Sets the outputs with IDs 232 to ID 238 and IDs 240 to ID255 to logical 1 and the outputs with IDs 0 ID 6 and ID239 to logical O VIPpanel User s manual V1 1 12 8 2005 26 35 www mjbc ch VIP User s manual M J Butcher Consulting pane solution engineering L Oxdf Oxff Oxff Ox7f 0x00 0x80
9. the reset message is not performed withing a period of 10s a question mark will appear in the display meaning that the VIPpanel is operational but has not detected a communication partner As for the sequence which follows this is defied completely by your application VIPpanel User s manual V1 1 12 8 2005 16 35 www mjbc ch Jane M J Butcher Consultin VIP User s manual g solution engineering 7 What do I do when my design is complete The goal of the VIPpanel is to accelerate your project and thus to gain time and save costs Once you have created and tested your own functional front panel design using the VIPpanel as a rapid virtual prototyping tool you will have experience that the project could be started quickly and more time could be concentrated for the most important part your application Details such as the construction of the front panel its mechanical design electronic layout etc should not be of central importance these can be solved by experts based on your VIP panel design data Simply send us your VIPpanel design and we can quickly quote for the supply of prototypes or production equipment Whether with membrane keyboard or mechanical keys we can offer the optimal solution Do you have additional requirements Would you like your front panel to send Emails support remote control using a small web server or measure the local temperature to name just a few additional possibilities Then you are
10. to right s 22 so Bi z eo di dh un i eco Assign now contrast 1Line5 2 11 Font m oo g A A z aK Sines Font 8999 dud ae Shift commands mw errre f Shift cursor ws ms sel Address pointer Se rataca a Left Right 2 RAM Ser VIPpanel User s manual V1 1 12 8 2005 14 35 www mjbc ch Jane M J Butcher Consultin VIP User s manual g solution engineering Test input This is where text is entered to be sent to the LCD The text appears at the present cursor position in case this is outside of the LCD visible area it will also no be seen Characters which can not be entered from the keyboard can be entered using the C code convention xXX For example the character with the ASCII code 1 can be entered as x01 Tip If you wish to send a back slash to be displayed in the LCD display enter it twice V but be aware that most LCD font sets have a different symbol to the back slash at this position in the font table Display commands This is where raw LCD commands can be entered as defined by the command set of the LCD The entry is in hexadecimal form without leading Ox A sequence of command may be sent by separating each by a comma Eg 01 02 C0 Defining characters A number of user characters may be defined at the locations 0 through to 7 The lower 3 rows are only active when the LCD is set to display 5x11 bit characters in single line mode In this mode 2 LCD lines are used and the uppe
11. 0x00 in CGRAM CGRAM Command 0x40 Address 0 Afterwards 64 data bytes can be written whereby only the 5 LSB are valid In 5x8 Mode 8 characters with each 8 rows by 5 pixels can be defined The row address is incremented after each byte written After the write to the last line of character 0x07 the address counter overflow back to 0x00 The characters 0x00 and 0x08 0x01 and 0x09 0x07 and OxOf are interpreted as equal to the character in the range 0x00 0x07 Example D 0x40 0xOd sets the CGRAM address to 0x00 W Ox1f 0x11 0x11 0x11 0x11 0x11 0x11 0x11 OxOd defines the 5x8 character The address has been incremented to 0x08 D 0x78 Ox0d sets the CGRAM address to 0x38 character 0x07 W Ox1f Ox1f Ox1f Ox1f 0x00 0x00 0x00 0x00 OxOd defines the 5x8 character MI The address has been incremented back to 0x00 overflow W 0x00 0x00 0x00 0x00 Ox1f Ox1f Ox1f Ox1f OxOd defines the 5x8 character gg The address has been incremented to 0x08 AND the character 0x00 has been overwritten In 5x11 Mode 4 characters with each 11 rows by 5 pixels can be defined This mode is only possible in the LCD single line mode and requires an LCD with at least 2 lines The last 3 lines of the character are displayed on the lower LCD line and the lower 5 character lines on this LCD line are blank The row address is incremented after each byte written In order to define the a following character it is necessary to eit
12. 0x80 H E L L O W O R L D 0xOd This command writes HELLO WORLD starting at the first position in the LCD The VIPpanel sends an ACK once the complete command has been completed This command requests a byte to be read from the LCD memory Example G A OxOd This command requests the present value of the address counter see the LCD data sheet for complete details Example G R Ox0d This command requests the present content of internal RAM at the address counter address see the LCD data sheet for complete details The VIPpanel returns the answer without an ACK containing the following contents J Q Answer to the request G OxXX The value read from the LCD OxOd End character This command fills all LCD locations with a specific character This can for example be used to test all pixels of the the LCD Example P 0x40 Oxff OxOd 0x40 64 characters all locations of a 4 x 16 LCD will be written with black blocks the character Oxff is a black block After the command has been completed an ACK will be returned Warning Pattern lengths of less or equal to 1 are not allowed and will cause a NACK to be returned This command sets the background light level Example 1 B 0x00 Ox0d owitches the background light off Example 2 B Oxff OxOd owitches the background light on Example 3 B Ox6B OxOd Sets the background intensity to 42 of its maximal intensity 107 255 100
13. VID User s guide VIPpanel V1 1 Hanspeter Z ger El Ing ETH amp Mark John Butcher BSc Hons MPhil MIEE M J Butcher Consulting Bahnhofstrasse 13 5507 Mellingen Switzerland www mijbc ch O ANTROBUGHON e 4 2 COMMUNICA gne M RR 5 How does my application communicate with the ViPpanel ss 6 3 OUR HARDWARE se pae edet ins deese a a aa aeaa 8 4 INSTALLATION OF THE DEMO PROGRAM ON THE PC 8 Overview of the Demo Program a un nee een 8 5 OPERATION OF THE VIPPANEE u 9 Creation or modification of a front panel eeeeeee eee eL eeeseeee eene nennen nnn nhan nnne nnn nnn 9 Opening a design in the front panel simulator eeeeeeeeeeeeee eere eene 9 Drawing a new front panel e me ee 9 DETINING KEY Tre 10 BAS IP n M 11 Addingan LED 11 Saving your MEW desig scene 11 Setting ih amp communication paramelers nun 12 SET A MCT LAC C ee Esa ea i E se i 12 Ethernet EAN an een ee MN etude a veram E ub UpU tus 12 Communication monitor ih 13 Trace wiNndoW Rain 14 ECD Control Panel scene 14 SS EN CR DN ERROREM 15 Display Commands c sss secsesssessessecssessecsscssessucsucsseccucsusssecsucsussuecsecsucsaresecsucsussucsucsaresecsucsaessecsesssessessucsaeeneesace
14. and has completed presently saved contrast setting This also allows the saved value to be verified Should the LCD not possess controllable contrast circuitry this command will not be recognised and a NACK will be returned Telegrams for LED control Writes a given byte to all outputs LEDs N Xx LED Intensity N Ox4e Controls the intensity of the LEDs default is maximum intensity The VIP panel supports up to 256 LEDs or other outputs Depending on the front panel type or design it is possible to use outputs grouped together for example to control mulicolour LEDs Alternatives to LEDs are for example relay and optocoupler outputs which can be controlled using the same commands The O command sets a defined pattern to the outputs Examples O 0x00 Ox0d Sets all outputs to the logical 0 state O OxFF 0x0d Sets all outputs to the logical 1 state This command can also be used to control small front panels with up to 8 outputs in which case the L command needs never to be used Using the L command outputs can be individually controlled oince most applications either use only a few outputs intensively the first 7 ID 0 6 are handled specially VIPpanel User s manual V1 1 12 8 2005 25 35 www mjbc ch ane M J Butcher Consultin VIP User s manual g solution engineering Example 1 L 0x55 Ox0d Sets the outputs with ID 0 2 4 and 6 to the logical 1 state and the
15. atibility and a secure connection The VIPpanel performs a parallel operation and transfers protocol messages between the Ethernet connector and the internal simulated serial port Your own designs based on serial port operation can thus also be simply tested in LAN mode if desired 10 100M LAN operation An Internet enabled front panel can often be set for 10M or 100M LAN operation as well as auto negotiation It should be noted when throughput is not an issue the 10M mode setting may be a good choice since it requires less power consumption than the 100M mode reference 400mW in 10M mode and 0 8W in 100M mode Nowadays switches are extensively used in Ethernet LANs and these adapt to the devices speed setting This is not the case when hubs are used to interface the device to a network in this case the devices speed must be set to that of the hub s speed otherwise the connection will not work VIPpanel User s manual V1 1 12 8 2005 33 35 www mjbc ch Jane M J Butcher Consultin VID User s manual g solution engineering 10 Appendix C Tips for the control of LCDs User definable characters Character displays support up to 8 user definable characters These are situated in the font table from address 0x00 and there are 16 spaces for these characters since they be either 5x8 or 5x11 in size In order to program the characters the appropriate address must be set in CGRAM The command D 0x400 OxOd for example sets the address
16. certainly at the right place we can advise you of the best solution and you can profit from our expertise and enjoy the service we can offer in the form of your brand new hardware and continuing support VIP panel User s manual V1 1 12 8 2005 17 35 www mjbc ch ane M J Butcher Consultin VIP User s manual g solution engineering 8 Appendix A Format of the telegrams Here you fin complete details concerning the protocol used to communicate with the VIPpanel This information is necessary to create your own applications which communicate with the VIPpanel or VIPpanel conform hardware front panels Format of the telegrams The telegrams which are sent between your device and the VIPpanel use the following basic format Command Optional additional commands Data End character End character OxOd Carriage Return CR Depending on the command the receiver may have to send an acknowledgment back The acknowledgement has the basis format ACK End character ACK 0x06 In case the receiver receives an invalid command it sends a NACK back NACK End character NACK 0x15 Generally the transmitter may not send further commands until the previous one has been confirmed ACK NACK or other expected response The transmitter should be capable of repeating telegrams which have not been responded to within a certain time Timeout Should the End charcater 0xOd occur within the telegram body it should be replace
17. ctable behaviour Due to these experiences and the complex behavious when a shift write is performed at a line change this mode needs to be carefully used and is often not recommended It is suggested that the VIPpanel control be first tested it corresponds to normal LCD operation and the shift operation possibly be implemented in the control software VIPpanel User s manual V1 1 12 8 2005 35 35 www mjbc ch
18. d by Ox1b OxOd ESC CR Should the escape character 0x1b occur within the body it should be replaced by Ox1b Ox1b ESC ESC The receiver removes the initial ESC in these cases VIPpanel User s manual V1 1 12 8 2005 18 35 www mjbc ch ane M J Butcher Consultin VIP User s manual g solution engineering Telegrams for reset and configuration Messages from the VIPpanel Reset r 0x72 Sent 100ms after a reset No commands should beb sent to the VIPpanel before this message has been received Exception h Mode and State h 0x68 xx yy Response to a network contact only in netzwork operation see appendix B Confirm mode setting im Ox6d xx Confirms the operating mode of the ViPpanel Response to the Type t 0x74 xx Gives details about the VIP panel model Request type Commands to the VIPpanel R 0x52 Commands a reset of the VIPpanel 0x55 OxAA This command is sent in Mode 0 meaning OxCC 0x33 without check sum etc and 0x55aacc33 represents a magic number Contact request H 0x48 Attempt to establish a connection with a netzwork enabled front panel see appendix B Switch connection to a new F 0x46 Transfer a network connection for an partner existing partner to a new one see appendix B Type request T 0x54 Requests the VIPpanel model type information V M I Set operating mode Sets the operating mode of the VIPpanel Accept operating mode A 0x42 Accept
19. ded development can be possible using for example VisualStudio and we can advise you personally if required Output windows ofthe VIPpanel Simulation mode of operation The application and the VIP panel run on a PC and communicate with each other via a software interface VIPpanel User s manual V1 1 12 8 2005 6 35 www mjbc ch X M J Butcher Consultin VIP User s manual g solution engineering With the ViPpanel configured in interface mode it can control a standard front panel in parallel mode of operation depending on the type either via the serial interface or Ethernet LAN xs ee Standard front panel Standardfrontplatte Serial or LAN Parallel mode of operation The application and the VIPpanel run on a PC and communicate with each other via a software interface An external front panel is controlled in parallel with the VIPpanel gt In case you have a hardware which is to communicate with the VIPpanel simply send us your VIPpanel design and we will configure the project free of charge to operate with your design and your target Output windows f the VIP I pane Embedded Hardware Application VIPpanel with HW Configuration Serial or LAN Hardware mode of operation Application
20. e Move it to its new position and click again to lock it to the new position Note All objects in the design including keys can be displayed by using command Show Objects F4 in the Edit menu The objects can be hidden by using the command Hide objects F5 in the Edit menu VIP panel User s manual V1 1 12 8 2005 10 35 www mjbc ch Jane M J Butcher Consultin VID User s manual g solution engineering Defining LEDs You can add up to 256 LED IDs to your front panel design These LEDs can then be controlled by using protocol commands The procedure is very similar to the definition of keys gt Activate the item Define LEDs F7 in the Edit Menu gt Draw an LED by clicking the left mouse key at the centre of the LED location while holding the SHIFT key down and pulling the radius of the circle to represent the LED circumference A dialog box is automatically opened where the parameters of the LED are visible and the LED ID s can be modified if required Follow the instructions for the definition if keys and define in addition the LED colour when its ID is in the active logical 1 and inactive logical 0 state Dual colour LEDs can be defined in which case 2 IDs are necessary In this case 4 colours are possible corresponding to the 4 possible state combinations of the two IDs For example 00 off 01 green 10 red 11 orange An LED can be repositionen by dragging with the mouse First show
21. e defined front panel designs with 2 or 4 line LCD displays joystick or matrix keyboard and also 3 bi colour LEDs In addition the application window shows a switch and an analogue voltage control these elements are part of the demo application and not the front panel Notes concerning the protocol settings used by the demo program see the protocol description for more details e he Demo program operates in event mode not polling mode since this is the preferred and most efficient mode e The application sends acknowledgements in response to key events e Messages are transmitted with as sequence number and a check sum CRC 16 in LAN mode The last 3 settings ensure a very secure connection and are not always necessary The Demo application can be configured to operate with other protocol settings for test purposes see the instructions to the demo application By changing the inputs in the application window and pressing keys on the VIPpanel a number of different functions can be tested You can also modify the design of the front panel as you wish and experience how your own design then becomes operational The operation of the Demo application is described in detail in the document VIPpanel Demo Application We hope that you enjoy the test VIP panel User s manual V1 1 12 8 2005 8 35 www mjbc ch Jane M J Butcher Consultin VID User s manual g solution engineering 5 Operation of the VIPpanel Creation o
22. e out period If the Supervisor wants to immediately give up the Supervisor connection it can do so by setting a normal connection UDP Protocol UDP User Datagram Protocol is an efficient TCP IP protocol which is connectionless TCP is for exampe connection oriented The protocol is however not reliable since it doesn t include data integrity checking and doesn t use handshaking The VIPpanel always uses active message counters and CRC 16 when operating in Ethernet mode in order to ensure a robust and secure connection This mode must be respected since the VIPpanel doesn t accept operation without these parameters A UDP frame carrying the VIP panel protocol has the following construct ETHERNET HEADER INTERNET PROTOCOL UDP HEADER DATA VIPpanel telegram including message counter and CRC 16 The VIPpanel protocol packet still uses escape sequencing VIPpanel User s manual V1 1 12 8 2005 32 35 www mjbc ch Jane M J Butcher Consultin VIP User s manual g solution engineering Ethernet Internet with VIPpanel and the Demo Application The demo application uses a simulated serial connection between the VIP panel and the application When you establish a LAN connection from the demo application to a VIPpanel conform front panel the application is informed and automatically switches to the correct protocol operating mode so that the LAN mode works The protocol operates now with message counter and CRC 16 to ensure comp
23. el sends automatically after a delay of 100ms a reset message to the application The application thus knows that the VIPpanel has been started the ViPpanel expects an acknowledgment from the application This message is repeted every 2 seconds until the acknowledgement has been received After a period of 10s without receiving an acknowledgement to the reset message the VIPpanel writes a question mark in the LCD display This process is repeated every 10s to show that the VIPpanel is operational but has not detected a communication partner Initially the VIPpanel is in the polling mode of operation In this state it doesn t inform of events apart from a reset and it is the job of the application to request such information regularly using a status request This mode is used effectively only in very simple applications since the Event mode of operation is usually more suitable The LCD is configured automatically by the VIP panel the cursor is invisible at the start of the first line The LCD backlight if controllable is switched off The LCD contast if controllable is set to its default level All outputs are deactivated The application does not need to perform any initialisation of its own As soon as the application receives the reset message from the VIP panel it may control it Nornally this starts with a request of VIPpanel settings and status and the setting of the operating mode check sum event mode etc If the acknowledgement to
24. elegrams do not use a message counter 1 All telegrams including ACKs are sent with a message counter This avoids a repeated message being treated a second time if it were to be repeated due to a lost ACK This security mechanism is especially useful in network operation where long delays may occur or the rate of message loss can be high Example The message counter is added just before a check sum if present 1 Telegram to the VIP panel W H e l F o 0x23 Oxd Hello will be displayed 2 ACK vom VIPpanel lost during transmission 0x06 0x23 OxOd 3 Repeated telegram W H e i jJ jo 0x23 Oxd The VIPpanel doesnt treat this message because the message counter has not changed if it were to be treated the display content would be HelloHello The VIPpanel expects another counter than 0x23 exactly which is not important 4 ACK from the VIPpanel 0x06 0x23 OxOd This ACK is successfully received Note Review the Application Note VIPpanel Demo Applicationfor examples how the counter can be successfully implemented to allow parallel operation VIPpanel and external front panel hardware in parallel Bit 4 0 2 NO CRC 16 used 1 Alle telegrams including ACKS are sent with CRC 16 and the CRC 16 check sum of received telegrams is verified Messages received with incorrect CRC 16 are ignored The CRC 16 check VIPpanel User s manual V1 1 12 8 2005 21 35 www mjbc ch ane M J Butcher Consultin VIP
25. ers The communication parameters are needed if the VIP panel is to be used either in the parallel mode of operation with an external front panel The settings are defined in the menu Communication Communication settings For use with our standard front panel the correct settings can be found in the corresponding product specification Serial interface The transmission speed Baud rate parity and number of Stopp bits can be set and the COM interface of the PC selected The VIPpanel protocol does not require flow control at the HS 232 level Ethernet LAN Certain front panels support a connection via an Ethernet LAN or the Internet The IP address of the hardware and the port number it uses must be set here Warning Firewalls can block certain IP Port combinations If there are firewalls between the LAN capable front panel ViP panel and the appliciation their settings must be verified We can advise you in this case If you do encounter any difficulties See appendix B for more details VIP panel User s manual V1 1 12 8 2005 12 35 www mjbc ch VID Communication monitor User s manual M J Butcher Consulting solution engineering The communication monitor enables the observation of the VIPpanel communication protocol between the VIPpanel and the application Select the monitor in the menu View TX RX Monitor on off The telegrams can in addition be saved to a log file This can be set in the menu View
26. ers of the key are visible and the key ID can be modified if required The parameters are Name This is the object name eg KEY 1 which may be used later for add in context sensitive support such as help text for the key Tool Tip Add a Tool Tip fort he key which will be displayed when the user holds the mouse over it For example Press this key to start program X ID Every key requires a key ID which can have the value from 0 to 255 It is best to start from 0 and defin eth emost often used keys in the range 0 6 When the key is pressed its ID is sent to the application ID 0 0x01 ID 1 0x02 ID 2 0x04 ID 3 0x08 etc until ID 255 0x8000000000000000000000000000000000000000000000000000000000000000 You will however see in the protocol description that such long values do not actually have to be transmitted The next lowest available ID is automatically suggested for each new key by the dialog and this can be accepted or modified as required Dimension Position the exact size and position of the key press area is displayed This procedure is repeated for each key in the design You can perform a right mouse click on a key at any time to reactivate its characteristic dialog and modify parameters or delete the key if desired A key can be repositionen by dragging with the mouse First show objects in the design F4 and press and hold the SHIFT button Click once on the key to be moved to lock it to the mous
27. est V Software Version request W Write display Z buZZer control VIPpanel User s manual V1 1 12 8 2005 VIP User s manual 30 35 M J Butcher Consulting solution engineering www mjbc ch Jane M J Butcher Consultin VID User s manual g solution engineering 9 Appendix B Communication over Ethernet TCP IP The communication over Ethernet differs from that of a serial connection in several respects e The connection can either be very fast for example over an Intranet or very slow example over the Internet e Some data loss is probably collisions transmission errors router errors etc Such a connection is simply less reliable than a direct serial connection e tis possible that there are more than one connection attempts from different sources e The location and IP addresses of the communication partners can change Due to these differences there are several aspects which must be considered in order to ensure reliable communication Reset After the reset of an Internet enabled front panel the Reset message is sent to a single fixed location This is generally not a problem in an Intranet since the Partner IP address can be configured and the link is equivalent to a fixed point to point connection It is a different situation if the Partner has not been configured or its IP address is not knows for example when the Partner received a temporary IP address from a service provider or DHCP server I
28. he following information v response to the request V OxXX OxXX OxXX OxOd Software major version 0x00 Oxff Software minor version 0x00 Oxff Software revision 0x00 Oxff End character Example V 0x02 0x05 0x03 0x0d Software version 2 5 3 VIPpanel User s manual V1 1 12 8 2005 20 35 www mjbc ch VIP User s manual M J Butcher Consulting ee solution engineering Using the M command it is possible to set the following operating modes Non defined bits should be set to zero to ensure compatibility OxXX BitO 0 Polling Mode Default 1 Event mode preferred Bit 1 0 No ACK expected to key status messages 1 VIPpanel expects ACK to key status messages only in Event mode of operation Key status messages will be repeated if there is no ACK received within a defined period of time The repetition will include further change information if this is available Bit2 02 NO Checksum used 1 All messages are sent with Prufsumme and the check sum of received messages are verified Telegrams with invalid check sums are ignored The check sum is calculated by CS NOT B1 B2 B3 Bx are all commands and data excluding the end character and excluding any additional ESC characters Example of an ACK with check sum 0x06 Oxf9 OxOd Note The VIPpanel transmits the confirmation m to this command in the modus in which it was in as it received the M command Bit 3 0 T
29. her command the start address of the character or else write dummy values into the last 5 line of a previous character which increments the address to the start of the next one In this mode the characters 0x00 and 0x01 0x02 and 0x03 0x06 and 0x07 are represented by the characters 0x00 0x02 0x04 and 0x06 As in the 5 x 8 Mode the address counter overflows after the character 0x07 and the characters 0x08 0x09 0x0f are equivalent to the characters 0x00 0x07 Example D 0x40 OxOd sets the CGRAM address 0x00 characters 0x00 and 0x01 VIP panel User s manual V1 1 12 8 2005 34 35 www mjbc ch d ll janel User s manual M J Butcher Consulting LLL solution engineering W Ox1f 0x11 0x11 0x11 0x11 0x11 0x11 0x11 0x11 0x11 0x11 OxOd defines the 5x11character The address has bee incremented to OxOb D 0x50 Ox0d sets the CGRAM address to 0x10 characters 0x02 and 0x03 W Ox1f Ox1f Ox1f Ox1f 0x00 0x00 0x00 0x00 0x00 0x00 0x00 OxOd defines the 5x1 1 character Mf Note lt is not recommended to switch between 5x8 and 5x11 modes during normal operation Different LCD types tend to react diffently and often unpredicatably when this is attempted Shift mode The LCD simulator in the VIPpanel attempts to reproduce the exact behaviour of a real LCD When text is written to the LCD display in shift mode it is often observed that different LCD types can behave slightly differently Some LCDs types also show unpredi
30. imised for the job The protocol is suitable for both direct serial connections and networks For differing requirements the protocol can be configured for simple operation when there are no high levels of security necessary or robustness for high transmission security in harsh environments You application can either operate on a Windows PC or directly on your target hardware In the first case the application communicates over a defined software interface with the VIPpanel and in the latter via the PC serial interface or Ethernet LAN The protocol remains basically the same The communication is based on a simple serial master slave operation where the application is the master and the VIPpanel is the slave Commands are individually acknowledged by the on VIPpanel completion Events at the VIPpanel for example changes of key states are sent automatically to the application or the state can be polled The format of the telegrams is detailed in Appendix A VIPpanel User s manual V1 1 12 8 2005 5 35 www mjbc ch VIP User s manual M J Butcher Consulting How does my application communicate with the VIPpanel There are various possibilities to communicate with the VIPpanel but basically 2 procedures f your application operates under Windows it can communicate with the VIP panel directly via DLL library functions You can find information in the Application Note Demo project for the VIPpanel There you can learn how an embed
31. ineering Key settings and responses Messages from the VIPpanel Key change event Key changes this is automatically sent when operating in event mode or as response to a key status request Commands to the VIPpanel Key status K 0x48 Requests the present key state this can be used to poll the keys Buzzer ON OFF E 0x45 xx Turns the automatic key beep on or off l XX Setting for auto beep I 0x49 oets automatic beep to individual keys this setting requires that the key beep is activated by using the E command The protocol for key change events uses the same format as that used to control LEDs The status of the first 7 keys with IDs 0 6 is transmitted using non addressed messages If there are more than 7 keys higher IDs greater than ID6 are transmitted using addressed messages If there are more than one key change at the same time all changes are reported in single message Keys are debounced by the VIPpanel with a debounce time of about 50ms which meansn that no two changes will be sent at a facter rate than this Whether the VIPpanel expects an ACK in response to a key change depends on its operating mode If the ACK mode of operation has been selected key changes which do not receive an ACK within a period of 1s will be repeated up to 7 times The VIPpanel responds with a k response rather than an ACK All changes since the last request will be reported Should the status be requested a
32. ing LLL solution engineering 1 Introduction The VIPpanel is a Windows program which allows a complete front panel with keys LEDs and LC Display to be simulated The VIPpanel enables in addition the creation and simulation of your own front panel designs and it can be used as input output device for connection to your own hardware and embedded applications The communication between your hardware application and the VIPpanel takes place either via the serial port or Ethernet LAN interface of the PC The VIPpanel design the number of keys and their sizes the number of LEDs and the type of LCD display are all freely definable Based on your design data we can deliver the corresponding hardware in a short time During this time the VIPpanel can be used for the continuation or completion of the application development New in the Version V1 1 e New command enabling the setting of the text position and writing text in one operation e Improved network support when multiple users are accessing the device e Keys and LEDs can be repositionen using the mouse e he VIPpanel Software available in both english and German VIPpanel User s manual V1 1 12 8 2005 4 35 www mjbc ch d ll janel User s manual M J Butcher Consulting S panel solution engineering 2 Communication The ViPpanel simulates the behaviour of a front panel 1 1 and communicates with the application via a defined interface using a protocol which has been opt
33. m length of the message and thus the number of individual command bytes depends on the buffer size which was signalled in the type response the command D is also to be counted Example D 0x01 Ox0e 0x18 OxOd This command performs the commands 0x01 Ox0e and 0x18 in this order A typical LCD would delete the display make the cursor visible and set the display to shift mode to the left The VIPpanel sends an ACK as confirmation once all of the individual commands have been completed Text or symbols are written to the LCD display with this command The maximum length of the text depends on the buffer size which was signalled in the type response the command W is also to be counted Example W H E L L O W O R L D Ox0d This command writes HELLO WORLD to the display Details such as the position of the text and the schift mode of operation must have been set beforehand using LCD command The VIPpanel sends an ACK as confirmation once the complete text has been written VIPpanel User s manual V1 1 12 8 2005 23 35 www mjbc ch 3 7 JETER M J Butcher Consultin VIP User s manual g solution engineering This command sets first the cursor position and then writes the desired text or symbols The maximum length of the text depends on the buffer size which was signalled in the type response the command S is also to be counted along with the cursor position byte Example S
34. n 15 DE a Co Sys ated m e iru pa E LV LL ices bade 15 6 OPERATING PRINCIPAL OF THE VIPPANEL s 16 Treating OL Key DICSSCS me 16 Conirol oT the LED un la 16 Heset and Initlallsation io s noc REOR aa eie 16 7 WHAT DO I DO WHEN MY DESIGN IS COMPLETE 17 8 APPENDIX A FORMAT OF THE TELEGRAMS 18 genio mifi 18 Telegrams for reset and configuration ee eere eeeee eere eee nnne nennen nennen nnn nnn 19 Telegrams for LED Control nee 22 Telegrams I0or LED COnNlr l 2 u eek 25 Key settings and TESDONSECS occisos ev u 28 IE r eeurtaeElrzei meim T 29 Overview of telegrams u nun ae 30 9 APPENDIX B COMMUNICATION OVER ETHERNET TCP IP 31 PROS OU c 31 ESTaDUISHING COnlact 2 EN 31 REED ale eee cette a ea Gel a Bee ae eb anal Sa AS Dar El el ba eb ae Be el ee 32 UDP PrOlOCOl ea ne a ee ore ee rarer ap nee 32 Ethernet Internet with VIPpanel and the Demo Application 33 107100M LAN Operation mu 33 10 APPENDIX C TIPS FOR THE CONTROL OF LCDS 34 User definable characters ctm 34 SHIIE MOde ins isons cm 35 d ll janel User s manual M J Butcher Consult
35. n this case the Reset message can not be delivered and a missing partner needs to be identified by another means Establishing contact If the Partner IP address has been configured and the front panel sends the Reset r message to this partner address a link will be immediately established analogue to a serial connection Should this not be the case a connection can be actively established by using the H command The front panel answers with its present operating mode as well as the present connection status The answer h 0x01 0x00 OxOd shows for example the mode 0x01 and the connection status 0x00 The connection states are 0x00 No existing connection a normal connection will be immediately established OxX1 A normal connection exists this connection will not be interrupted OxX2 Supervisor connection exists this connection will not be interrupted OxXf Unknown connections are not allowed Should the connection already exist with the requesting communication partner then the bit 0x10 will be set in the status message for example 0x11 means that a normal connection already exists with the requesting communication partner It is to be noted that the Ethernet operation always uses a CRC 16 and counter mode of operation No existig connection The connection link will be immediately set to the requesting IP address The status changes to normal connection VIPpanel User s manual V1 1 12 8 2005 31 35 www
36. nel with the dimensions 135mm x 70mm you should create the drawing with these dimensions Paint allows this for example using picture attributes Draw your new front panel with your desired colours patterns and fonts and add drawings of keys in their desired sizes and colours You can set frames for the positioning of LCD display and LEDs if you wish but this is not absolutely necessary since they will b eadded in the VIP panel later Alternatively you can modify an existing design by exporting it to a Bitmap File Export front panel BMP editing it in a drawing program and finaly re importing it to the VIPpanel File Import front panel BMP When the front panel is imported all elements such as keys LEDs and LCD remain in the design Should you wish to start with a fresh design it is best to use File New design which deletes all design elements and start with a fresh sheet VIPpanel User s manual V1 1 12 8 2005 9 35 www mjbc ch d ll janel User s manual M J Butcher Consulting pane 0 solution engineering Defining keys So that the VIPpanel knows where the keys are in an imported design these must first be defined You can add up to 256 keys Activate the item Define Keys F6 in the Edit Menu gt Draw a key by clicking the left mouse key while holding the SHIFT key down and pulling the rectangle to represent the active key press area A dialog box is automatically opened where the paramet
37. r 8 rows of the character assigned to an even ASCII character code are displayed in the top line and the lower 3 rows assigned to next odd ASCII character code in the bottom line VIP panel User s manual V1 1 12 8 2005 15 35 www mjbc ch Jane M J Butcher Consultin VIP User s manual g solution engineering 6 Operating principal of the VIPpanel Treating of key presses When the left mouse key click occurs on an area defined as a key a message is sent with the corresponding key ID bit set see the protocol description in appendix A When the mouse button is let go a second message is sent to inform of this fact where the ID bit has been removed Several keys can be pressed and held by using the SHIFT key on the PC keyboard When the SHIFT key is held each click on a key causes the key state to toggle between pressed and released Each change causes the corresponding message to be sent When the SHIFT key on the PC keyboard is released all keys are released and a message sent accordingly Control of the LCD The control of the LCD and LEDs is performed by the application or Demo application The VIP panel allows and its LCD can be controlled without restriction by using the corresponding protocol messages In order to control the LCD an understanding of the LCD hardware is necessary but the VIPpanel aids this with its build in LCD Control Panel see above Reset and initialisation After a reset or power up the ViPpan
38. r modification of a front panel The creation of a new design consists essentially of 5 steps In case you want to modify an existing design various steps can be left out Design of the front panel including keys in a drawing program Import of the design in the front panel simulator VIPpanel Definition of key press areas and their corresponding key codes IDs Definition of LEDs and their corresponding LED codes IDs Choice and positioning of an LCD display VVVVV In the following description it is assumed that you begin with one of the existing front panel designs Opening a design in the front panel simulator When the VIPpanel starts it automatically loads the last used design You can however chice from a number of designs delivered with the VIPpanel Simply select File Open design and choose a design with VIP extension A design includes the front panel as well as all elements such as LCD keys and LEDs Drawing a new front panel You can very simply create your new front panel design using your favourite drawing program for example PhotoShop PaintShop or with the simple drawing program Paint which is a part of the standard Windows installation Alternatively existing designs can be used as templates and modified as desired The front panel ist displayed in its real size by the VIPpanel and it is therefore important that the Bitmap is created with the correct size If for example you wish to create a front pa
39. runs on the target hardware VIP panel User s manual V1 1 12 8 2005 7 35 www mjbc ch Jane M J Butcher Consultin VIP User s manual g solution engineering 3 Our Hardware As well as the VIPpanel we supply several multi functional standard front panels Depending on the type each is equipped with serial and or Ethernet LAN interfaces The front panels use the same communication protocol as the VIPpanel and can be operated in parallel to the VIP panel see parallel mode of operation above To learn how to configure the VIPpanels for the parallel mode of operation see the chapter Setting the communication parameters 4 Installation of the Demo Program on the PC The Demo Program for the VIPpanel is delivered either as VisualStudio Projekt or as executable with installation program Should you prefer to use the executable simple start the installation program and follow the guide The VisualStudio project can be compiled and operated with Microsoft VisualStudio This Demo program starts the VIPpanel and shows several capabilities of the LCD display using a simple menu controlled interface The VisualStudio project allows modifications to be made to the application as well as new front panel creations to be made Without the VisualStudio project it is not possible to modify the Demo program but the VIPpanel can be used without limits to create and test new designs Overview of the Demo Program The Demo program is based on pr
40. s a new operating mode Xx Software request V 0x56 Requests the version of the software in the VIPpanel M XX VIP panel User s manual V1 1 12 8 2005 19 35 www mjbc ch VID User s manual M J Butcher Consulting solution engineering 0 The VIPpanel responds without ACK to the type request T and returns the following information t Response to the request T OxXX OxXX Model recognition 0x00 0xff Model type 0x00 Oxff OxXX OxXX Buffer size 0x00 Oxffff Format Big Endian This is the size of the OxXX OxXX OxXX OxOd Options 1 0x01 0x02 0x04 0x08 0x10 0x20 2 reception buffer in the VIP panel which should never be exceeded It restricts the length of messages to the VIPpanel This maximum length includes all commands and data but not the end character and not escape characacters since these are never saved in the reception buffer Numer of keys 1 0x00 0xff 0x00 1 Oxff 2 256 Number of LEDs 1 0x00 0xff 0x00 1 Oxff 256 Options 1 Should there be no options this and following bytes are not sent Optionen 2 Additional options if available etc End character LCD background light can be switched on and off LCD background light intensity can be controlled LCD contrast can be controlled LED brightness can be controlled Buzze available Buzzer supports variable frequencies The VIPpanel responds without ACK to the Request V and returns t
41. t a too low rate less often than about 100ms it is possible that very short key presses are missed For this reason the event mode of operation is to be preferred This request is especially useful immediately after the front panel has startet in order to recognise keys which were in a pressed state on power up A K response with no data means that there were no changes since the last request and an empty response after power up signifies that no keys were held down at power up 9 E 0x01 OxOd Activates key beeps E 0x00 Ox0d Deactivates key beeps E 0x02 Ox0d Activates individual key beeps for individual keys which have been assigned by using the I command Attention this function is only available in event mode The front panel does not generate key beeps in polling mode The VIPpanel responds with an ACK This command has the same format as the LED control telegram VIPpanel User s manual V1 1 12 8 2005 28 35 www mjbc ch JETER M J Butcher Consultin VIP User s manual g solution engineering When a key ID is set to a logical 1 the ViPpanel generates a beep when the corresponding key is pressed The tone has a frequency of 3000Hz and lasts 75ms This setting is only valid when the E command has set the buzzer mode accordingly This message is always acknowledged with an ACK as long as its format is correct whether there is a buzzer available or not A NACK is returned shoud the format be incorrec
42. t and the command wil be ignored Telegrams for Buzzer control Commands to the VIPpanel Buzzer tone Z 0x5a xx yy Generates a beep with variable frequency and length 1 The buzzer may be used for acoustic signalisation The command Z OxXX OxYY OxOd switches the buzzer on for a period of OxXX times 50ms and with a frequency of OxYY times 100Hz A duration of O switches the buzzer on continuously A frequency of O switches a continuous tone off again This command is always acknowledged immediately with and ACK In case the hardware is not capable of generating the requested frequency the buzzer will be activated with the next best possible frequency If the hardware doesn t support a buzzer the command is ignored The automatic key beep is deactivated when a tone is being generated by the buzzer If a second such command is received before the first duration has completed the second command takes over from the previous command VIPpanel User s manual V1 1 12 8 2005 29 35 www mjbc ch Overview of telegrams A Accept B Backlight C Contrast D Display control E key bEep On Off F Force Connection G Get LCD Memory A Address R RAM H Hi Network contact P Individual key beep K Key status request L set LEDs or outputs M Mode JN LED iNtensity O Output pattern T set Pattern to LCD R Reset Roy Set Position and write display gt V1 1 T Type requ
43. t the mode possibly with deviations from the demanded mode or try a different setting by resending the m command A 0x01 Oxbd 0x0d The application accepts the new mode and sends the Accept command in the new mode with message counter and check sum The VIPpanel checks the message in the new mode and finishes the sequence with an ACK in the new mode VIPpanel User s manual V1 1 12 8 2005 22 35 www mjbc ch ane M J Butcher Consultin VIP User s manual g solution engineering or sro Both sides are now operating in the new mode In nthis case both using a message couter and check sum Telegrams for LCD control Commands to the VIPpanel LCD Command D 0x44 xx This command is used to directly control the LCD according to its instruction set LCD Text W 0x57 xx Writes text to the present position in the LCD LCD Set Text S 0x53 Sets the text position and then writes text at that position 2 V1 1 D W e LCD Read G 0x47 xx Returns the contents of the LCD memory P 0x50 y B 8 C XX LCD Test P 0x50 xx Writes a test pattern to all locations of the y LCD Backlight B 0x42 xx Controls On Off and brightness of the backlight Contrast C 0x43 xx Controls the LCD contrast and can save the value as default 0 The LCD command can be used to send one or a number of individual LCD control commands to the LCD The maximu
Download Pdf Manuals
Related Search