Congratulations on your purchase of Amulet's Starter Kit. Please take a few minutes to read this file which contains the latest information about setting up and using your Amulet starter kit. This documentation is valid for software version 3.3.5.
The Amulet method of displaying graphics on an LCD is totally different from traditional methods. The Amulet Browser Chip handles all the LCD and touchpanel functions so your micro doesn't have to. Hardware wise, the only requirement is that your micro needs a UART in order to use the Amulet system. On the software side, you need to create an Amulet serial protocol handler. Generally, the only thing that is being sent via the serial link is data.
Here's the Amulet system in a nutshell.
1. HTML authoring tools
are used to create a Graphical User Interface(GUI).
2. The Amulet HTMLCompiler is
used
to compile your GUI to a small binary file which is then downloaded into the
Amulet module.
3. The Amulet module displays the GUI and handles
all touchpanel interaction.
4. The Amulet module receives
input data from your host microprocessor via the serial link and also sends command messages to
your micro based upon timer-based or touchpanel events.
There are two types of variables in the Amulet system. External variables (byte, word and string) which reside on your micro's side and InternalRAM variables (byte, word and string) which reside on the Amulet module. InternalRAM is quasi-dual port RAM that can be read from and written to by the Amulet chip through commands inserted in the HTML code. Your micro interfaces to InternalRAM through the serial link. There are specific UART commands that can read from and write to InternalRAM.
There are four major types of serial messages that will be sent between the
Amulet module and your micro.
1. A request of a variable (byte, word or
string)
2. A setting of a variable (byte, word or string)
3. A Remote
Procedure Call, which is a completely generic message which allows the Amulet module to inform your micro of a certain event. You can have up to 256 unique
RPC's. What those RPC's signify is entirely up to you.
4. A raw byte, or
group of bytes, can be sent from the Amulet module to your micro. This
option is not part of the Amulet serial protocol, but rather it gives you the
flexibility to have the Amulet module send you small commands that do not
need to be answered.
Please see the UART Protocol
document for more details.
Your LCD's user interface is created using standard HTML authoring tools, such as Front Page, Dreamweaver, Namo etc... To complement the standard HTML, Amulet has created a number of I/O objects, referred to as Amulet Widgets which can be inserted into the HTML source code via the APPLET tag. There are two types of Amulet Widgets, Control Widgets and View Widgets. Control Widgets are input objects, like function buttons, sliders, radio buttons, etc... Control Widgets have a function, or a set of functions, that can be applied to them. For instance, a function button can be set to send a Remote Procedure Call #5 out the UART every time it is pressed. View Widgets are output objects, like bargraphs, numeric fields, string fields, etc... View Widgets call a function which returns the data used as the input for that particular widget. For instance, a bargraph can have a function which requests external byte variable #3 every 100ms over the UART.
The complexity of the serial protocol handler depends upon the type of communication you will be using in your system. You can set up your project so that the Amulet module is the master, requesting data at given update rates and sending command messages asynchronously. Or your micro can be the master, sending data to the Amulet module unsolicited. And you can also use a dual master setup, where the Amulet module is sending asynchronous command messages to your micro, yet your micro is also sending unsolicited data to the Amulet.
The Amulet starter kit contains everything you need to start creating feature-rich user interfaces for any embedded device.
If you haven't already done so, please take the time to work through the informative
tour and example projects that are included in your Amulet Starter Kit. The
tour will provide you with an overview of how to configure, compile and program
the Flash of your Amulet Starter Kit. The Examples are provided to show you
how to use some of Amulet's most powerful features.
What will I learn in Quick Start?
Click here, to run the 5.7" Quick Start.
If you have the 3.8" Starter Kit, click here
for the 3.8" Quick Start.
What will I learn from the Examples?
Click here, to view more info about the Example projects.
If you are reading this, it is likely that you have already installed the compiler. If not, then Insert the Amulet installation CD into your CD-ROM drive. The Setup program should launch automatically. If this does not happen, follow the steps below:
Follow the onscreen directions to complete the rest of this installation.
With the permission of Namo, Amulet has provided a trial version of Namo WebEditor 6 on the install CD which you must install separate from the Amulet HTMLCompiler. By installing Namo WebEditor 6, you adhere to the End User License Agreement set forth by Namo during the install. If you would like to purchase the full version of Namo WebEditor 6, you can do so by going to Namo's web site, http://www.namo.com
To install the trial version of Namo WebEditor 6, insert the Amulet installation CD into your CD-ROM drive. If the Amulet HTMLCompiler Setup program should launch automatically, cancel the Setup program and follow the steps below:
Follow the onscreen directions to complete the rest of this installation.
With the permission of Docklight, Amulet has provided a trial version of Docklight on the install CD which you must install separate from the Amulet HTMLCompiler. By installing Docklight, you adhere to the End User License Agreement set forth by Docklight during the install. If you would like to purchase the full version of Docklight, you can do so by going to Docklight's web site, http://www.docklight.de
To install the trial version of Docklight, insert the Amulet installation CD into your CD-ROM drive. If the Amulet HTMLCompiler Setup program should launch automatically, cancel the Setup program and follow the steps below:
Follow the onscreen directions to complete the rest of this installation.
HTMLCompiler help is actually a website made up of HTML pages. The home page is named readme.htm and is installed on your hardrive in the HTMLCompiler's main directory -- typically C:\Program Files\Amulet\readme.htm. HTMLCompiler help can be "browsed" from most recent browsers, however, frames capability is recommended for best results.
When you invoke help from within HTMLCompiler, help\help.htm is invoked by passing it to the Windows API ShellExecute. This will perform the equivalent of double-clicking on the HTML file in Windows Explorer. In most cases, this will invoke your preferred browser.
NOTE: If you have the file association for .HTM files set to open an HTML editor, or some other program,
that program will be opened, instead of your browser, when you invoke help from within HTMLCompiler.
Copyright © 2000-2005 Amulet Technologies, LLC. All rights reserved. This documentation and the accompanying
software are copyrighted materials.
U.S. and Foreign patents pending.
Amulet Technologies, LLC warrants the products it sells against defects in materials and workmanship for a period of 90 days. If you discover a defect, we will, at our option, repair, replace, or refund the purchase price. Return the product with a description of the problem. We will return the product or its replacement via standard shipping. IMPORTANT: Subjecting the product to conditions outside specified limits, or attempting to repair or modify the product, voids this warranty.
Other than the warranty described above, Amulet Technologies, LLC gives no additional warranty either expressed or implied and specifically disclaims all other warranties, including warranties for merchantability and fitness. In no event shall the liability of Amulet Technologies, LLC exceed the buyer's purchase price, nor shall Amulet Technologies be liable for any indirect or consequential damages.
Products sold by Amulet Technologies, LLC have not been approved for use in critical medical, life-support, or life-saving devices or applications.
Amulet Technologies, the Amulet Logo, Easy GUI, and µHTML are trademarks of Amulet Technologies, LLC.
Windows® is a registered trademark of Microsoft, Inc. Other trademarked names that may be mentioned in the
body of these documents are the property of their respective holders.
If you find a bug, have a question, or would like to suggest an enhancement, please contact us via e-mail at devSupport@AmuletTechnologies.com
The most current version of the HTMLCompiler, including any bug corrections, may be found on our website at http://www.AmuletTechnologies.com