The Amulet HTMLCompiler compiles HTML and image files into a single compact µHTML project. Additionally,
µHTML projects may be saved to a file (with a .uht or .pdb extension) or programmed into the flash
memory of an Amulet
module.
For more detail on using the HTMLCompiler, click on the following topics:
HTMLCompiler runs on Windows 95, 98, ME, 2000, XP, Vista and NT 4.0 or later. HTMLCompiler may be invoked by any standard Windows method:
Like most websites, most µHTML projects contain multiple pages. However, all action starts at the "home
page". In a µHTML GUI, the home page is the first page that is displayed on the Amulet LCD after boot
up. Since all other display pages can be traced back to the home page through hypertext links, the HTMLCompiler
can build a complete µHTML project by starting with the HTML file for the home page.
To create a µHTML project:
You may save the results of a successful compile to a file. All µHTML projects should be saved to files
with either the .uht or .pdb extension. You can use any other extension, but the HTMLCompiler will ONLY load projects saved with
the .uht or .pdb extension.
To save a µHTML project:
You may reload the results of any pre-compiled µHTML projects that have been saved to a file with a .uht
extension. NOTE: the HTMLCompiler will ONLY load projects saved with the .uht extension.
To load a µHTML project:
Optionally, you may double click on any file with the .uht extension. Windows will automatically launch the
HTMLCompiler and load the *.uht µHTML project.
Also, if executing from the DOS command line, a pre-compiled *.uht file may be optionally specified as follows:
C:\Program Files\Amulet\HTMLCompiler file.uht
In the above case, file.uht will be automatically loaded and prepared for flash programming.
You can use the HTMLCompiler to save the contents of the currently displayed uHTML page on an Amulet powered display. The HTMLCompiler will only allow you to save the screenshot with a .bmp extension. If you try to use any other extension like a .gif, then the HTMLCompiler will not save the screenshot.
To save a screenshot:
Note, the Upload Image function assumes you are dealing with a 320x240 sized display at 115200 baud. If your display is a different size, you need to modify one of the current OS files. Here are the steps needed to allow a 480x320 display perform an image upload.
By default, the HTML page within the Amulet OS that initiates the upload is set to 115200 baud. The HTMLCompiler uses the baud rate specified in Settings > RS232 > uP Comm Rate to transfer the image. If you are having problems with your image upload, ensure your HTMLCompiler Settings > RS232 > uP Comm Rate is set to 115200. If you need to upload the image at a baud rate other than 115200, you can modify the Amulet OS file ScreenDump.ahtml. Here are the steps you need to allow the Upload Image to work at 19200.
The HTMLCompiler uses an RS232 port on your PC to program the flash memory of your Amulet
module. Prior to programming for the first time, you must select a comm port, select the programming and auto "wake-up" baud rates. The HTMLCompiler stores these settings in its Amulet.ini file so that they can be recalled each time you launch the HTMLCompiler.
To select a serial port for programming:
The HTMLCompiler has added a new feature which adds support for different size LCD's. Prior to programming for the first time, you must specify and program the LCD characteristics of the exact display you'll be using, only if using a display other than the one Amulet supplied in the starter kit or module kit. The HTMLCompiler stores the LCD settings in individual .ini files located in \Displays\ subdirectory of the Amulet main directory.
To select a different size LCD:
NOTES:
The Amulet OS and your compiled project both reside in the installed serial data flash on board the Amulet module. If your project becomes larger than the size of your flash, the HTMLCompiler will display a warning message. The serial data flash can be upgraded from 1MBit to either a 2MBit, 4MBit or 8MBit part. If your Amulet module has a larger sized serial data flash, then you can specify your actual flash size to keep the warning message from showing up when not appropriate.
To specify the size of the flash installed in your Amulet module, select Flash Size from the Settings menu of the HTMLCompiler. Choose the appropriate size (1MBit, 2MBit, 4MBit or 8MBit) and press the OK button.
Note: This will not change the size of the flash installed in your Amulet module. The size specified here should reflect the size of the installed serial data flash module.
Menu: Settings > HTMLCompiler Preferences
The HTMLCompiler Preferences menu allows you to customize the colors that are used in displaying the HTMLCompiler, the size of the border around the console window and also allows you to add "Save .pdb" and "Save .uht" buttons.
Color Preferences:
The background, the text and the frame can all be set to one of 13 colors. A sample of what your choices will look like is displayed in the right hand side of the menu. Be aware that if you choose the same color for both the background and the text, you will not be able to see any text in the console window.
Layout Preferences:
By selecting the Minimal Frame checkbox, only a small border along the bottom will appear on the HTMLCompiler. This merely changes the look of the HTMLCompiler. You can see the difference a border makes by looking at the sample to the right.
You can also enable the "Save .pdb" button and/or the "Save .uht" button. After a successful compile, these buttons will appear along the bottom of the HTMLCompiler, thus allowing for quick saving of a .uht or .pdb file. These buttons will create a .uht or .pdb file with the same name as the name of the file chosen to compile. They will not give you a chance to save the files as a different name and they will write over any existing file of the same name without giving you a warning message.
If you are happy with your changes, then select the OK button. If you want to disregard the changes you made, select the CANCEL button. If the OK button is selected, the Preferences menu is closed down and the HTMLCompiler will now reflect the changes that you entered.
By default, the Program Flash button is disabled. To enable the button you must either compile
a project or load a previously compiled project.
To program the Amulet's Flash memory:
Switch 1 (Boot Mode) = ON (normal) (*See
Note below) Switch 2 (Program Baud Rate) = OFF (115200) or ON (19200) NOTE: This must match the bit rate set for the compiler. Switch 3 (RAM Test) = OFF (disabled) Switch 4 (Touch Panel Mode) = ON (Normal operation) |
* Note: Upon clicking on the Program Flash button in the Compiler window, the Compiler will attempt to send out an auto "wake-up" message to the Amulet controller. If the page currently being displayed is set up to use the same baud rate using the META tag (if META is not present, the default is 115200) as the Compiler's uP comm rate, then the Amulet controller will change to a generic "Please wait while programming flash..." screen and commence programming. If the page has a baud rate different than what the Compiler is set to, then you should set the uP comm rate in the Settings->RS232 dialog box to match the baud rate set by the META tag. This will allow the HTMLCompiler to wake up the Amulet at one baud rate and then program it at another baud rate. The only time you should have to put the Amulet into program mode (DIP Switch 1 to OFF on the 5.7" or Boot M not jumpered on the 3.8") is when the project you compiled locks up the Amulet OS to the point where it won't accept the wake up message or if the Amulet OS has been corrupted and you need to reload the OS.
NOTES:
You may, at anytime, restore the Amulet flash memory to the original factory configuration.
If you are updating from a previous version of Amulet software you MUST update your firmware. Follow the steps below if your Amulet no longer seems to work correctly. If your module does not have a touchpanel, see section below.
-OR-
If you are updating a module that does not have a touchpanel, then you'll need to load the file AmuletOSv3.3.5_NT.uht instead of AmuletOSv3.3.5.uht. The regular OS requires touchpanel calibration upon loading. The _NT file does not have this requirement.
After loading the "No Touchpanel" OS, if you need to change the polarity, you obviously won't be able to change it through the LCD, since you can't use the touchpanel to select the ""Toggle Display Polarity" button, but you can by going into the LCD Settings menu and either selecting your specific LCD from the list of LCD Types, or you can create your own custom LCD settings, including the display polarity and save that LCD type. After selecting the LCD settings for your specific display, you can then hit the Program Now button.
Make sure that the "Force Touchscreen Calibration" checkbox is unchecked, otherwise you will be forced to run the touchscreen calibration before displaying anything else.
When going into production, it is often desirable to program a single file into the production units. Amulet provides you with the ability to combine your project with a raw OS file. A raw Amulet OS file contains all the same files as the regular Amulet OS, without the initial project which shows the version number of the Amulet OS and gives you the ability to change the polarity of the display. To use the raw Amulet OS file, you must provide it with a project to start up with. To see a comprehensive example on doing this, click here for the CustomOS example.
You can combine multiple .uht files by creating an Amulet script file, which is a text file with a .AmuletOS extension. You then open this .AmuletOS file in the HTMLCompiler and save the results as a .uht or .pdb file.
.AmuletOS files need to contain the name of a project previously saved as a .uht file along with the name of a raw Amulet OS file. The final line should contain NoFontHdr. All folders are relative to the folder containing the .AmuletOS file.
NOTE: A raw Amulet OS file contains all the files needed for the OS, but no initial project. It should never be loaded by itself. It should only be used in conjunction with another project and packaged together via a .AmuletOS file. Conversely, you should never try to package a full Amulet OS file with another project in a .AmuletOS file.
Here is an example of a custom .AmuletOS file for a fictitious project named ACME. Assume ACME.uht and ACME.AmuletOS reside in the Amulet\projects\ACME folder.
..\..\binaries\AmuletOSv3.3.5_RAW.uht
ACME.uht
NoFontHdr
Notice that we're using the raw OS file found in the Amulet\binaries folder. The directory containing the .AmuletOS file is considered the root directory and everything else is relative to the root inside of the .AmuletOS file. Opening this .AmuletOS file in the HTMLCompiler combines the raw OS file with the pre-compiled project, which you can then save as a single .uht or .pdb.
By default, the raw Amulet OS is set up as a 320x240 AOB3202405B. You can also specify the characteristics that are specific to the display you are using and packaging that information with the .uht you created from the .AmuletOS file. By entering the Settings->LCD menu choice from the HTMLCompiler, you can specify the following in your custom OS:
LCD size and type
Display Polarity
Frame Frequency
Choose to
Force Touchscreen Calibration upon first boot up or not
See above for more information regarding using the LCD settings dialog. Upon setting your custom LCD characteristics, check the Always Program Settings checkbox and hit the Save button. Now open your .AmuletOS file with the HTMLCompiler and save as a .uht or .pdb. This single .uht (or .pdb) will contain both the project and the OS specified in the .Amulet OS file as well as the LCD configurations you specified in the LCD settings dialog.
Note: After successful creation of your custom OS file, if you do not uncheck the Always Program Setting checkbox, then every time you program the flash, those settings will be uploaded every time. If the existing OS already has the settings you want, there is no need to reload them. But, if the Force Touchscreen Calibration checkbox is set as well, this will result in you needing to recalibrate the touchscreen after every new Flash programming.
See a full example on how to use the .AmuletOS file in conjunction with the LCD settings dialog by clicking here.
Along with the windowed version of the HTMLCompiler, the Amulet software suite also includes a command line version named HTMLCompilerCL. As the HTMLCompilerCL does not open a window, all options need to be specified by switches on the command line. HTMLCompilerCL does use the same configuration file, Amulet.ini, as the windowed HTMLCompiler, so the RS-232 and LCD settings will default to the settings last used in the windowed HTMLCompiler if no switches are used on the command line.
To get a help screen, use the /? switch.
To program specific LCD Settings (i.e. LCD Height, Display Polarity, Backlight Intensity, etc...) along with the project, use the /I switch along with the path and name of a specific display's .ini file. .ini files are generated in the windowed version of the HTMLCompiler in the Settings > LCD menu and stored in the Amulet\Displays directory. See the LCD Settings documentation for more information. For example, to program the project CompileMe.htm from the projects\MyProject directory along with your own LCD settings which are saved in a file called MyLCD.ini, use the following command line command:
HTMLCompilerCL /P /IDisplays\MyLCD.ini projects\MyProject\CompileMe.htm
While compiling, all the error and status messages that are normally found in the HTMLCompiler are sent to the DOS console window. For example, if compiling and programming CompileMe.htm from the projects\Examples\BarGraph directory, the console window should look like this:
In order to call the HTMLCompilerCL from another directory, ensure that the Amulet root directory is included in your PATH. The name of the file to compile is always relative to the Amulet root directory, regardless of the calling directory. For instance, to compile and program Home.html located in C:\Program Files\Amulet\projects\MyProject, use the following
HTMLCompilerCL /P projects\MyProject\Home.html
Upon a successful compile (and programming of the flash, if applicable), the HTMLCompilerCL exits with a code of 0. If any error occurs in either the compile or the programming to flash, an exit code of -1 is returned. DOS refers to exit codes as ERRORLEVEL.
Almost all the screens that come with the Amulet OS can be customized. A copy of all the pages which can be customized can be found under the Amulet\projects\OS Files directory. Within the OS Files directory, there are six sub-directories. All OS files have the extension .ahtml. Here is a synopsis of what each sub-directory holds:
If you are creating a Custom OS, then you can modify these files and use them in place of the files that come bundled with the OS .uht file. Keep in mind that you will need to ensure that you program these modified files after programming the OS .uht file. That means that the modified OS files will need to appear after the OS .uht within the .AmuletOS script file.
When compiling, loading, saving, or Flash programming, the HTMLCompiler provides feedback to you in two different ways: on the Status Line, and in the Message Area
Open... | Open HTML (*.htm, *.html) file to compile, or any previously compiled µHTML (*.uht) project. Brings up a file dialog for choosing file. |
Open Last |
Open the last file that was compiled and recompile it. |
Restore Amulet OS | Opens the latest Amulet OS and also programs it into the Amulet's flash memory. |
Save .uht |
Save compiled project in µHTML (*.uht) format. The name is automatically generated by replacing the extension of the file compiled with .uht. Will overwrite an existing file with the same name without asking. |
Save .pdb |
Save a compiled project in Palm DataBase (*.pdb) format. The name is automatically generated by replacing the extension of the file compiled with .pdb. Will overwrite an existing file with the same name without asking. |
Save .uht as... | Save a compiled project in µHTML (*.uht) format. Brings up a file dialog for choosing the name and location
to save the *.uht project file. NOTE: Filename MUST have a .uht extension! |
Save .pdb as... | Save a compiled project in Palm DataBase (*.pdb) format. Brings up a file dialog for choosing the name and location
to save the *.pdb project file. NOTE: Filename MUST have a .pdb extension! Contact Amulet Technologies for the Palm software needed to program a .pdb project file into the Amulet onboard Flash PROM. |
Program Flash |
Programs the resultant compiled project into the Amulet's flash memory. Same functionality as the Program Flash button in the lower right hand corner of the HTMLCompiler. |
Upload Image | Upload and save the contents of the currently displayed uHTML page on an Amulet powered LCD. |
1)...5) |
Contains the names and directories of the last five pages compiled. Selecting one of these menu choices immediately recompiles that page. |
Exit | Exit the program. |
RS232 | Brings up the RS232 settings dialog used to configure the COM port for programming the Amulet onboard serial data flash. |
LCD | Brings up the LCD characteristics dialog used to configure the Amulet module for different size LCD's. |
Flash Size |
Brings up the Flash Size dialog used to specify the size of the flash memory installed on your Amulet module. |
HTMLCompiler Preferences |
Brings up the HTMLCompiler Skin dialog, used to customize the look of the HTMLCompiler. |
Help... | Brings up this help document. |
Check For Updates |
Launches a browser to http://www.amulettechnologies.com/support/downloads/softupdates.html so you can check for software updates. |
About... | Brings up a dialog containing information about the Amulet HTMLCompiler and about your computer. |