4D Arduino Adaptor Shield DATASHEET DOCUMENT DATE: 08th MARCH 2019 DOCUMENT REVISION: 1.4 4Display-Adaptor-Shield ** Hardware Revision 2.01** Arduino and variant Compatible Shield Uncontrolled Copy when printed or downloaded. Please refer to the 4D Systems website for the latest Revision of this document W W W . 4 D S Y S T E M S . C O M . A U Table of Contents Table of Contents 1. Description .................................................................................................................................... 3 2. Configuration Options ................................................................................................................... 4 Header 1 (H1) .......................................................................................................................... 4 Header 2 (H2) .......................................................................................................................... 4 Arduino Reset Button (T1) ...................................................................................................... 4 Jumper 1 (J1) ........................................................................................................................... 5 Jumper 2 (J2) ........................................................................................................................... 5 Jumper 3 (J3) ........................................................................................................................... 5 Jumper 4 (J4) ........................................................................................................................... 5 3. Schematic Diagram HW REV 2.01 .................................................................................................. 6 4. Hardware Connection Overview .................................................................................................... 7 5. Advanced Hardware Options ......................................................................................................... 8 6. Specifications and Ratings ............................................................................................................. 9 7. Hardware Revision History .......................................................................................................... 10 8. Datasheet Revision History .......................................................................................................... 10 9. Legal Notice ................................................................................................................................. 11 10. Contact Information .................................................................................................................... 11 4D Arduino Adaptor Shield Page 2 of 11 www.4dsystems.com.au 4D Arduino Adaptor Shield 1. Description ** This Datasheet is for the Hardware Revision 2.xx of the 4D Arduino Adaptor Shield, not for the Hardware Revision 1 4D Arduino Adaptor Shield. Please refer to the 4D Arduino Adaptor Shield product page on the 4D Systems website for the datasheet on the previous model if required ** The 4D Arduino* Adaptor Shield (4Display-AdaptorShield) is a simple Arduino Shield designed to provide a convenient interface to attach 4D Systems display modules to the Arduino platform, without having to use jumper wires on the Arduino headers. Arduino Shields, such as the Intel Galileo, Arduino Due etc. The 4D Arduino Adaptor is compatible with most Arduino and clones. Works with 3.3V and 5.0V I/O Arduino modules, provided a 5V supply exists from the Arduino itself, or if no 5V supply exists, an external 5v supply must be connected via the H2 Header, and J2 jumper moved accordingly. Arduino Libraries are available to download from the 4D Systems website, www.4dsystems.com.au The Arduino Adaptor Shield is included in various Arduino Module Packs, but can be purchased separately if a 4D Display Module is not required or is owned already. Communication to the 4D Systems Display Modules is performed via the Arduinos serial port, and is provided to the user in a simple 5-pin interface, where a 5 way cable (included in the Arduino Module Packs) can be attached between the Shield and the Display Module. A single digital on the Arduino is utilised for an external reset for the display, and can be disconnected if required. Jumpers are provided to enable selection between different I/O to offer more flexibility over the REV 1 design. Please refer to Section 2 for more information. 4D Arduino Adaptor Shield Top Power for the display is supplied from the Arduino's 5V bus, or via an external source such as a 4D Programming Cable or 5V power supply. The 4D Arduino Adaptor Shield is compatible with the following 4D Systems display modules: uOLED-xx-G1/G2 modules uLCD-xx-G1/G2 modules uLCD-xx-PT modules uLCD-43 (All versions) uLCD-xx-PTU modules uVGA-II/III modules uLCD-35DT uLCD-70DT + Future models While older modules from 4D Systems may be pin compatible, the 4D Arduino Libraries may not specifically support them. 4D Arduino Adaptor Shield Bottom NOTE (*): Arduino remains the property of the Arduino Team. All references to the word Arduino and Arduino Hardware are licensed under the Creative Commons Attribution Share-Alike license This Adaptor Shield is also compatible with other platforms which feature Arduino style headers and use 4D Arduino Adaptor Shield Page 3 of 11 www.4dsystems.com.au 4D Arduino Adaptor Shield 2. Configuration Options On the 4D Arduino Adaptor, four jumpers (J1, J2, J3 and J4) have been added to provide flexibility to the users Arduino project, to enable I/O to be changed or disabled as required, including the power source for the display. J1 H2 J2 J4 J3 H1 Header 1 (H1) Header 1 (H1) is used to connect the 4D Arduino Adaptor Shield to the 4D Systems display module of choice, using the 5 way cable supplied with the shield. This cable provides 5V, GND, TX, RX and Reset signals to/from the display and Arduino, allowing them to communicate. Header 2 (H2) A 4D Programming Cable/Adaptor connector (H2) has been added which can be used to power the display module in the case the display being used requires more power than can be provided by the Arduino (for example if the Arduino is powered off a laptop USB rather than a 5V Jack). If the 4D Programming Cable/Adaptor isn't used and an external power supply is, then the RES pin can be used to reset the display externally, if required. See J1 below. The power supply source is determined by the J2 jumper, please refer below. NOTE: The RX and TX Signals from the 4D Programming Cable/Adaptor are NOT passed from this header, it is used to provide additional power only. Arduino Reset Button (T1) T1 is a reset button for the Arduino, not for the display. This allows access to the Arduino's reset button which may be covered up when a shield in placed on top of the Arduino for a number of the Arduino models. 4D Arduino Adaptor Shield Page 4 of 11 www.4dsystems.com.au 4D Arduino Adaptor Shield Jumper 1 (J1) J1 enables the Display Reset to be changed from being triggered from the Arduino on GPIO D4 when in the AR position, or from the H2 connector by means of an external source, when in the PR position. If the jumper is connected between the AR pin and the central RES pin, then the display can be reset by setting D4 high in the Arduino logic, and then low again. If the jumper is connected between the PR pin and the central RES pin, then the display reset is controlled via the H2 Connector. This could be switched low by an external circuit, providing an external method of resetting the display. Removing the jumper from J1 entirely will disconnect the displays Reset from the Arduino completely, which may be valid for some projects. Note: D4 is always pulled low to GND via a 4.7K Resistor due to the nature of the reset circuit. So even if the J1 is disconnected, the Arduino D4 input is always going to have a 4.7K pull down on it. In most cases this should not affect operation of D4 if it is to be used for something else in a project when J1 is disconnected, however it should be noted that this is the case when using this shield. Jumper 2 (J2) J2 enables the Power Source for the display to be changed from being powered via the Arduino's 5V Supply, or via the H2 connector. If the Arduino is powered from the Users' computers USB, some computers cannot provide enough current for both the Arduino and the Display to be powered off the same USB port, so auxiliary power can be required. If J2 is connected between the AR pin and the central PWR pin, then the display is powered off the Arduino's 5V supply. If J2 is connected between the PR pin and the central PWR pin, then the display is powered off the H2 connector, via something like the 4D Programming Cable. 5V could also come from an external power source if desired. Removing the jumper from J2 entirely will disconnect power from the display. Jumper 3 (J3) J3 enables the Serial signals from the display to be received either onto D0 or D2. D0 on most Arduinos is the Hardware Serial Port 0 RX Pin. D2 is often used for Software Serial. This allows flexibility for different setups. If the jumper is connected between the D0 pin and the central RX pin, then the Arduino's hardware serial port 0 will be connected to the display. In this configuration, programming of the Arduino is not possible without disconnecting the display, as the USB programming signals for the Arduino will also be received by the display, which will result is corrupt programming signals being received if the Display transmits anything, resulting in a failed programming attempt. Disconnecting this jumper will disconnect the Arduino from the Display, allowing the Arduino to be programmed. If the jumper is connected between the D2 pin and the central RX pin, this will allow Software Serial (or similar) to be used to communicate to the display. The Arduino should be able to be programmed successfully when the jumper is in this position without having to remove the display from H1 due to the display and Arduino not sharing the same serial port as the Arduino's USB programming. If desired, a jumper wire can be placed from the central pin of J3, to a completely different pin on the Arduino, such as D19 on an Arduino Mega, allowing Hardware Serial1 to be used. Jumper wires are not included. Jumper 4 (J4) J4 enables the Serial signal to the display to be transmitted from either the Arduino's D1 or D3 pins. D1 on most Arduinos is the Hardware Serial Port 0 TX Pin. D3 is often used for Software Serial. Please refer to the description for J3 above, the same applies for J4. If the jumper is connected between the D1 pin and the central TX pin, then the Arduino's hardware serial port 0 will be connected to the display. If the jumper is connected between the D3 pin and the central TX pin, will allow Software Serial to be used to communicate to the display. Removing the jumper will disconnect the Arduino from the Display. If desired, a jumper wire can be placed from the central pin of J4, to a completely different pin on the Arduino, such as D18 on an Arduino Mega, allowing Hardware Serial1 to be used. Jumper wires are not included. 4D Arduino Adaptor Shield Page 5 of 11 www.4dsystems.com.au 4D Arduino Adaptor Shield 3. Schematic Diagram HW REV 2.01 4D Arduino Adaptor Shield Page 6 of 11 www.4dsystems.com.au 4D Arduino Adaptor Shield 4. Hardware Connection Overview The following pictures illustrate how to connect the parts of the AR kit together. Note, the display module illustrated below is the gen4-uLCD-24DT. The kit you have will obviously determine what display you have. This is just an example. Components in a typical gen4 AR Kit. Components in the AR Kit connected together. Arduino Adaptor Shield shown then connects on top of the customers Arduino board (not included). 4D Arduino Adaptor Shield Page 7 of 11 www.4dsystems.com.au 4D Arduino Adaptor Shield 5. Advanced Hardware Options The display module (gen-uLCD-xx) is a very capable and powerful piece of hardware, which can be reconfigured beyond the boundaries of the Arduino. With the use of the 4D Systems Workshop4 IDE Software, the display module can be configured and programmed independently of the Arduino environment. If you wish to investigate the capabilities of the gen4 display module and reconfigure the display module, please refer to the Datasheet for that display module specifically, available from the 4D systems website, www.4dsystems.com.au. A lot more information is available inside the display modules datasheet than what is discussed in this datasheet. You can easily bring the module back to its default factory firmware/configuration by using the Workshop 4 IDE Software. To take advantage of the 4D Systems Workshop4 Software, a 4D Programming Adaptor is required, which is available from the 4D Systems website, or from a 4D Systems distributor. These are also available in various Starter Kits. The Workshop4 IDE enables the display module to be configured using 4 different environments. The Designer environment enables the user to write 4DGL code in its natural form to program the display module. A visual programming experience, suitably called ViSi, enables click-and-place type placement of objects to assist with 4DGL code generation and allows the user to visualise how the display will look while being developed. An advanced environment called ViSi-Genie doesn't require any 4DGL coding at all, it is all done automatically for you. Simply lay the display out with the objects you want, set the events to drive them and the code is written for you automatically. ViSi-Genie is a rapid development platform, which can be extended further with the purchase of a Workshop4 Pro license, available from the 4D Systems website. A Serial environment is also provided to transform the display module into a slave serial module, allowing the user to control the display from any host microcontroller or device with a serial port. This is the default configuration when the display module is shipped. Designer and ViSi allow you to program and write your own protocol to communicate between the Arduino and the Display Module, and write 4DGL code directly into the display module to create advanced GUI's and graphics. ViSi-Genie has a set protocol as outlined in the documentation associated with it (Available from the Workshop4 Product page of the website), and 4D Systems has developed an Arduino Library specifically for the ViSi-Genie environment, to enable a rapid development platform. The library is available for download from the gen4 display modules AR product page on the 4D Systems Website, www.4dsystems.com.au. The Serial environment loads an application (SPE) onto the display module which enables commands from the Arduino to communicate directly with the display module and get it to perform specific actions. 4D Systems has developed a library specifically for this environment also, which is available for download from the gen4 display modules AR product page on the 4D Systems Website, www.4dsystems.com.au. 4D Arduino Adaptor Shield Page 8 of 11 www.4dsystems.com.au 4D Arduino Adaptor Shield 6. Specifications and Ratings RECOMMENDED OPERATING CONDITIONS Parameter Supply Voltage (VCC) Conditions 5V supply from either the Arduino itself or from the H2 Header from an External source. Operating Temperature Min Typ Max Units 4.5 5.0 5.5 V -10 -- +70 C ORDERING INFORMATION Order Code: 4Display-Adaptor-Shield Packaging: Module sealed in antistatic foam padded 4D Systems Box 4D Arduino Adaptor Shield Page 9 of 11 www.4dsystems.com.au 4D Arduino Adaptor Shield 7. Hardware Revision History Revision Number Date 2.01 14/06/2013 Description Initial Public Release Version 8. Datasheet Revision History Revision Number Date 1.3 1.4 14/06/2013 04/03/2019 4D Arduino Adaptor Shield Description Initial Public Release Version Cosmetic changes, removed clutters, added 4th and 5th section Page 10 of 11 www.4dsystems.com.au 4D Arduino Adaptor Shield 9. Legal Notice Proprietary Information The information contained in this document is the property of 4D Systems Pty. Ltd. and may be the subject of patents pending or granted, and must not be copied or disclosed without prior written permission. 4D Systems endeavours to ensure that the information in this document is correct and fairly stated but does not accept liability for any error or omission. The development of 4D Systems products and services is continuous and published information may not be up to date. It is important to check the current position with 4D Systems. 4D Systems reserves the right to modify, update or makes changes to Specifications or written material without prior notice at any time. All trademarks belong to their respective owners and are recognised and acknowledged. Disclaimer of Warranties & Limitation of Liability 4D Systems makes no warranty, either expressed or implied with respect to any product, and specifically disclaims all other warranties, including, without limitation, warranties for merchantability, non-infringement and fitness for any particular purpose. Information contained in this publication regarding device applications and the like is provided only for your convenience and may be superseded by updates. It is your responsibility to ensure that your application meets with your specifications. Images and graphics used throughout this document are for illustrative purposes only. All images and graphics used are possible to be displayed on the 4D Systems range of products, however the quality may vary. In no event shall 4D Systems be liable to the buyer or to any third party for any indirect, incidental, special, consequential, punitive or exemplary damages (including without limitation lost profits, lost savings, or loss of business opportunity) arising out of or relating to any product or service provided or to be provided by 4D Systems, or the use or inability to use the same, even if 4D Systems has been advised of the possibility of such damages. 4D Systems products are not fault tolerant nor designed, manufactured or intended for use or resale as on line control equipment in hazardous environments requiring fail - safe performance, such as in the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, direct life support machines or weapons systems in which the failure of the product could lead directly to death, personal injury or severe physical or environmental damage (`High Risk Activities'). 4D Systems and its suppliers specifically disclaim any expressed or implied warranty of fitness for High Risk Activities. Use of 4D Systems' products and devices in 'High Risk Activities' and in any other application is entirely at the buyer's risk, and the buyer agrees to defend, indemnify and hold harmless 4D Systems from any and all damages, claims, suits, or expenses resulting from such use. No licenses are conveyed, implicitly or otherwise, under any 4D Systems intellectual property rights. 10. Contact Information For Technical Support: www.4dsystems.com.au/support For Sales Support: sales@4dsystems.com.au Website: www.4dsystems.com.au 4D Arduino Adaptor Shield Page 11 of 11 www.4dsystems.com.au