|
WWW Interface User Manual
Revision B - 11 APR 1996
|
Abstract
This document is a description of the Saida WWW Interface. The document contents are:
- Using the Interface.
Description of the interface from a user point of view.
- Managing the Interface.
Description of the interface from a management point of view.
- SEHTML Tags.
Description of the various SEHTML tags used in the interface templates.
1 Using the Interface
The WWW Interface consists of three parts:
- The start screen.
- The current status screen.
- The update status screen.
To prevent unauthorized access to the users domestic appliances, a user verification test has been included in the start screen.
1.1 Start Screen
Description
When a user is going to access his/her domestic appliances he/she must access the start screen and enter a user identification and a password. After pressing STATUS. the current status screen is generated (see [1.2], "Current Status Screen").
Screenshot from the start screen.
Path
http://194.47.159.61/es.html
1.2 Current Status Screen
Description
Before this screen is generated, both the user identification and password that have been typed in at the previous screen (see [1.1], "Start Screen") are validated. If they are incorrect, an error string is shown, otherwise the template specified in the password file (see [2.3], "Password Files") is used by generator.exe to display the
current status of the users domestic appliances.
The two fields correspond to two appliances. The "path1/name1" could for example be substituted with "ronneby/hogskolan/sikt/upper_floor/toaster". The input field to the left of the path/name text shows the current state of the appliance. If for example the first line would be the toaster mentioned, one could easily turn it off by editing the field from "ON" to "OFF" a
nd then press SUBMIT.
If the user decides to change some of the values displayed on this screen he/she must press the SUBMIT button to continue to the next screen ([1.3], "Update Status Screen"), otherwise the new values entered will be lost.
If everything is ok, i.e. the user don't want to change anything with his/her appliances, pressing BACK will open the main page.
Screenshot from the current status screen.
Path
None (generated by generator.exe - see [2.1], "Generator.exe").
1.3 Update Status Screen
Description
When the SUBMIT button in the previous screen (see [1.2], "Current Status Screen") has been pressed this page will be generated and displayed by updator.exe, reading the template specified in the password file (see [2.3], "Password Files"). If any error occurred trying to set the new values supplied in the current status screen, the co
rresponding error message will be displayed on this screen.
When the user is done with this screen, he/she just has to press the button labelled DONE to return to the main page. But if something went wrong, the user can press BACK to get another chance changing the data.
Screenshot from the update status screen.
Path
None. (generated by updator.exe - see [2.2], "Updator.exe").
2 Managing the Interface
The interface uses five kinds of files in the interaction with the user:
- Generator.exe.
- Updator.exe.
- Password Files.
- Generator Templates.
- Updator Templates.
2.1 Generator.exe
Description
This executable file is located on the CCN. The file takes two arguments (name and passwd) originating from the start screen (see [1.1], "Start Screen") that is used to verify the user and locate the users generator template path (see [2.3], "Password Files") in a password file. If the user was valid his/her generator template will be
presented on the current status screen ([1.2], "Current Status Screen").
Path
c:\saida\generator.exe
2.2 Updator.exe
Description
This executable file is located on the CCN. The program takes a number of arguments originating from the current status screen (see [1.2], "Current Status Screen"), including name, passwd and various number of variables (including their corresponding values). The name and passwd is used to verify the user and locate the users updator template path (see [2.3], "Password Files") in a password file. The updator.exe will then try to update the variables sent as argument to the program, and return possible error codes on the update status screen (see [1.3], "Update Status Screen").
Path
c:\saida\updator.exe
2.3 Password Files
Description
This file contains all the information necessary for allowing a user to access his domestic appliances. The file is used both by the executable files generator.exe (see [2.1], "Generator.exe") and updator.exe (see [2.2], "Updator.exe") to verify that users accessing the cgi-bin programs are valid.
Format
Plain ASCII text, where each entry consists of four fields:
- Identity.
- Password.
- Template filename used by the executable file generator.exe.
- Template filename used by the executable file updator.exe.
Example Syntax
.
id1*password1*generator-template-path1*updator-template-path1
id2*password2*generator-template-path2*updator-template-path2
.
2.4 Generator Templates
Description
This file contains HTML code including SEHTML (Saida Extended HTML). It is used by generator.exe (see [2.1], "Generator.exe") to generate the current status screen (see [1.2], "Current Status Screen") presented to the user. The file is basically a HTML FORM without the <FORM> and </FORM> tags.
Format
HTML code including SEHTML tags.
Example Syntax
.
<H1>You have <SGET VARIABLE="number_of_appliances"> appliances in your home</H1>
<TABLE WIDTH=340>
<TR><TD><SSET VARIABLE="Variable1"></TD>
<TR><TD><SSET VARIABLE="Variable1"></TD>
<TR><TD><BR><INPUT TYPE="SUBMIT" VALUE="Update"></TD>
</TABLE>
.
2.5 Updator Templates
Description
This file contains HTML code including SEHTML (Saida Extended HTML). It is used by updator.exe (see [2.2], "Updator.exe") to generate the update status screen (see [1.3], "Update Status Screen") presented to the user. The file is basically a HTML FORM without the <FORM> and </FORM> tags.
Format
HTML code including SEHTML tags.
Example Syntax
.
<TABLE WIDTH=340>
<TR><TD><SERR></TD>
<TR><TD><BR><INPUT TYPE="SUBMIT" VALUE="Back"></TD>
</TABLE>
.
2.6 Physical Overview
- Start Screen.
- Current Status Screen.
- Update Status Screen.
3 SEHTML Tags
Currently the following Saida Extended HTML tags are available:
3.1 SGET
Description
The SEHTML tag is used to retrieve the value of a certain variable. The retrieved data is then presented as a character string.
Syntax
<SGET VARIABLE="unique_variable_name">
3.2 SSET
Description
The SEHTML tag is used to retrieve both a variable name and its value. The retrieved data is then presented as a HTML text input-box.
Syntax
<SSET VARIABLE="unique_variable_name">
3.3 SERR
Description
The SEHTML tag is used to retrieve all possible error messages generated when the executable file updator.exe tries to set variable values.The retrieved data is then presented as a character string.
Syntax
<SERR>
- WWW Interface User Manual
-
- Abstract
-
- 1 - Using the Interface
-
- 1.1 - Start Screen
-
- Description
-
- Path
-
- 1.2 - Current Status Screen
-
- Description
-
- Path
-
- 1.3 - Update Status Screen
-
- Description
-
- Path
-
- 2 - Managing the Interface
-
- 2.1 - Generator.exe
-
- Description
-
- Path
-
- 2.2 - Updator.exe
-
- Description
-
- Path
-
- 2.3 - Password Files
-
- Description
-
- Format
-
- Example Syntax
-
- 2.4 - Generator Templates
-
- Description
-
- Format
-
- Example Syntax
-
- 2.5 - Updator Templates
-
- Description
-
- Format
-
- Example Syntax
-
- 2.6 - Physical Overview
-
- 3 - SEHTML Tags
-
- 3.1 - SGET
-
- Description
-
- Syntax
-
- 3.2 - SSET
-
- Description
-
- Syntax
-
- 3.3 - SERR
-
- Description
-
- Syntax
-
Info
Team
WebCam
Documents
Schedule
CustomerOnly
© 1996, The SAIDA Project