Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 62 Next »

Welcome!

Welcome to the EazyLink2 User Guide. This is displayed when you have selected the Help > User Guide menu item from the desktop application. You may also have arrived here through our project wiki navigation system. The words EazyLink and Eazylink2 are used interchangeability throughout this document.

This user guide is written for all the Desktop versions of the EazyLink. Where necessary, specific details of desktop operating system features will be mentioned by displaying the OS icon.

This user guide is being written at the moment, while we work on the Beta releases. We anticipate to have this work completed when EazyLink2 has reached final release of V1.0 .

 

We are on Open Source project and a small community, so any assistance you are able to give is most welcome. Create an account on this project (click on Log-in link on top right corner), it's free and safe; no email addresses are displayed anonymously. Once you have an account, you can start creating issues for EazyLink (or any other project) - or maybe you want to just follow our work and add comments - that is all up to you! As a registered user you will also be informed on the progress made on issue (use watches) and receive automated emails with popular (the most active) wiki-pages. Check out our project welcome page and browse through the projects we have (take a look at the dropdown menu here in top left corner of this web page).

Installation

To install Eazylink to your Desktop, download the application and run it from our software repository. Currently there are three versions available; for Windows, Mac OS X and Linux. The installers are quite self explanatory, behaving similarly on all three platforms.

On Windows however, the end-user will have a system warning screen about the software not being an officially signed application by Microsoft; this can be ignored (we don't write viruses and our software-installer is built on Linux or Mac OS X).

Antivirus software can also examine new programs and delete them without warning. This is called a 'false positive' error. If this happens to you, please report this to your virus software provider so that they can update their records

 

Connect the Z88 to the Desktop

The Z88 has a female 9 way 'D' RS-232 connector which is used to connect to the Desktop. The connections are not the standard PC type as the Z88 was around before that standard was adopted. The recommended way to connect them together is to use the PC to Z88 cable. The PC end of this cable of this cable (either a 9 or 25 way 'D' female connector) plugs into the Desktop's Serial Port.

Serial to USB converter

Desktops that use USB and not Serial ports, need a Serial to USB converter. Choose one that supports 'hardware handshaking' and a driver available for the Operating System you are using. The cable type puts less strain onto the connectors than the adapter type. A disk with the manual and drivers are normally supplied with the converter, but these drivers can be years out of date. You are advised to read the manual to see which driver it uses. Then use Google to search for the latest driver.

If you are purchasing a new converter, the ones that use the Prolific chip set are quite popular and support various Operating Systems. These two examples have been tested with Windows xp. Please let us know how they work with different Operating Systems.

http://www.amazon.co.uk/ABC-Products%C2%AE-converter-convertor-Converter/dp/B000Z3MBG8/ref=cm_cr_pr_sims_t

The CheckChip Version Tool reported it to be using one of the "End Of Life" chips. These are not going to be updated with new drivers.

http://www.amazon.co.uk/dp/B00425S1H8/?tag=uk77fansdelivery.co.uk-21

This one looks a better choice, it uses the PL2303HXD (HX Rev D) chip. The driver supports Windows 8.
Download the Latest Prolific Drivers here:
http://www.prolific.com.tw/eng/downloads.asp?ID=31

It is hoped that as more uses use this program a list of known Serial to USB converters can be listed here so that users may have a more informed choice.

Before running the program, you need to know the device name the operating system has allocated to the serial port you are using to connect to the Z88. This is either a physical number that is on the computer e,g, COM.1 COM.2 (device names on Windows). If you are using a Serial to USB converter the driver will automatically allocate a new serial port device name, please refer to the manufacturer's instructions for details how to find out that name (COM port number on Windows).

Terminology

There may be words or phrases that are used in this document that the user is unfamiliar with. Just in case you are one of them, they are covered here.

There are two types of Z88 programs. they behave in different ways. These are:-

  • Z88 Popdown
  • Z88 Application

A Z88 Popdown runs as a temporary program. When it is started, it will 'pop up' over what you doing before. When it is closed or exited by the ESC key, you are returned to the previous Z88 Application program you were running previously.

A Z88 Application on the other hand can be 'suspended' when you  leave it. This enables you to carry on where you left off. Suspended Z88 Applications are displayed on the INDEX page.

To close a Suspended Activity, move the cursor over the Z88 Application running and issue the <>KILL command.

Note: You will not see any Z88 Popdown listed here.

The EazyLink2 uses two programs.

  • EazyLink Client
  • EazyLink Server

The Eazylink Client is the one running on the Desktop. Once communication has been established, you control the suite from there.

The EazyLink Server runs on the Z88. Once you start it, you can put the Z88 to one side and leave it alone.

Using the Program

There are two Z88 Popdowns that this program supports. These are the :-

  • EazyLink Popdown
  • Imp-Export Popdown

The Eazylink Popdown is an additional application on the Z88.  All commands are operated on the Desktop. It is available on Flash or EPROM cards from Rakewell. Just follow the instructions that came with the card and the application will be ready to use. Should the user wishes to make their own copy, they can use Imp-Export to upload the application and blow the image on a card.

The Imp-Export Popdown is the standard communication application that is on all Z88. It enables users to connect to a Z88 without any additional applications. It supprts sending and receiving files but it requires the user to use both the Desktop's and Z88's keyboard.

WARNING - If you are using a slow Desktop, it is quite eay to start up multiple copies of Eazylink if you keep selecting it. Please be patient, select it once and wait. This is also true if the program becomes 'non-responsive,' wait until it responds again and then either shut it down or issue the next command. When closing the program, please ensure that any external command windows have been closed, otherwise you may produce a serial port lockup. These can only be cleared by rebooting the Desktop. 

EazyLink

This is the preferred mode of operating as it uses all the options offered from the Desktop.

EazyLink prerequisites

  • Install the software on the Client
  • Install EazyLink on the Z88
  • Connect the Z88 to the Client (with the Serial to USB Converter if required)

 

There are commands listed in the left-hand window. These are not normally used as all commands are sent from the Desktop. The only useful command is "QUIT EAZYLINK" or ESC to exit .

Which version are you running?

If you are running the 'stand-alone' version of the Eazylink application the version number is on the main HELP page.

If you are running Eazylink in OZ the version number isn't on the Eazylink HELP page.  

It is shown in grey in the bottom left-hand corner of the display. All versions of the Z88 Eazylink popdown will work with EazyLink2, the functions available will depend on the version used. As part of OZ V4.3, EazyLink V5.1 features were integrated then. The latest version, V5.2 functions were integrated into OZ V4.3.1, This was released in August 2012.  

 

 

If this is the first time you have run Eazylink, you will be directed to the:-

Setup Wizard

Please follow the instructions given carefully. If you know which Serial Port you are using with the Z88, use the list that displays the available ports to select this. If you are unsure which one it is, there is a 'Detect Z88' facility which can be used.

Select Settings and select the serial port device name the Z88 is connected to. If you are unsure which one this is

If you get a communication error, make a note of the messages on the Z88 screen and try again.

If you get continuous communication errors, go to Solving Communication Errors (see below).

The Display

Drop-down menu(s) are along the top. The two windows below display the files on the Z88 (left-hand) and the Desktop (right-hand). The files displayed initially may not be recognizable. This is because EazyLink2 selects the root directory of your main drive. This can be changed to where you want to store the files from the Z88. initially due to the wrong drive and directory

 

When the Z88 has connected successfully, the above display will be shown. Until the correct settings are found or used, you may get used to seeing this message. 

Reading Z88 Devices Command Failed!

The three responses (apart from 'not again') are:

ChoiceWhat should you do?
RetryTry this option a few times first and see if it it eventually connects.
IgnoreIf the above fails select this. It may not have connected. Select the "Eazylink Hello" command and see if it is being received by the Z88. If it is, then try again, if not...
AbortSelecting this disconnects the Z88. Go to the Serial Port to select the correct serial port, or run the Setup Wizard again.

 

The Commands

Top Menu

FileZ88 What do they do? 
Exit  Exit the program.
 Eazylink Hello  Issue a Hello command to the Z88. This is used to check whether the connection between the Desktop and Z88 is working correctly. You should see "Hello" appear on the Z88's screen if it is.
 Eazylink Quit This command disconnects the Z88 from this program. To reconnect, select the Serial Port and choose the connection again.
 Send files to Z88 Imp-Export popdown Send files to the Z88 using the built-in Imp-Export popdown that is supplied with all Z88s.
 Receive files from Z88 Imp-Export popdown Receive files from the Z88 using the built-in Imp-Export popdown that is supplied with all Z88s.
 Set Z88 Clock Use the Time and Date on the Desktop to set the Z88's clock.
 Read Z88 Clock Read the Z88's Time and Date clock settings on the Desktop.
 Reload Translation Table  
 Get Info Get information from the Z88 regarding ROM Version number, Devices and Memory.
    
 Settings  
 Serial Port Set which Serial Port the Z88 is connected to. See Com Port for further details.
 PreferencesGeneralThese 'tick box' selections allow user customisation.
 Sync Z88 Clock before file transfers to Z88. Checks and sets the Z88 clock (Date and Time) to the Desktop's if they are different before sending a file.
 Load Z88 File-Tree on Serial Port Open. Displays all your Z88 Devices and Files when the Z88 is connected.
 Shutdown Z88 Eazylink popdown on exit. Sends the command to the Z88's Eazylink popdown to close before exiting itself.
 Set Desktop Startup Directory as Root. The Desktop Startup Directory initially uses the Root. This directory can be changed (See Desktop Window / StartUp Dir). This option is a quick way to change it back again.
  TranslationsThe Z88's Eazylink popdown is able to change individual characters whilst transferring files. The following modes enables these translations.
Make sure that they are turned off if translations are not required when sending zip or BBC BASIC files.
 Enable Byte Mode Translation  
 Enable Z88 to CR/LF line termination This is used with text files. If the file appears to be one long line of text, this mode may correct this.
  Com PortThis is a repeat of the Serial Port above. Eazylink will not connect to the Z88, unless these settings are correct.
 Open Serial Port on Startup Enable this when Eazylink communication to the Z88 works to save setting it up when starting future sessions of the program.
 Default Serial Port: Displays available Serial Ports with the drop down menu. Set it to the Serial Port that the Z88 is connected to.
 Refresh Displays any additional Serial Ports that are available (except the one selected).
  ActionsThe user can customise the mouse to do different functions. Instructions on how to use and configre are given.
 Setup Wizard The Setup Wizard is run the first time Eazylink is run to help the user to connect to the Z88. This allows it to be used again.
    
 Help  
 User Guide This Guide, selected from the program
 About Information about Eazylink's Desktop Version Number and Date

 Z88 Line

This line repeats some of the commands above. They are here to enable quicker selection with the mouse.

 Command  What do they do?
EazyLink Hello  Sends the 'Hello" command to the Z88. This can be used to check that connection is made. The user will see 'Hello' on the Z88's screen if it is successful.
Z88 Refresh  The initial command sent to the Z88 to establish communication sent by the user.
Transfer Z88 <- Desk   
Transfer Desk -> Z88   
Display File Size  Selecting this gets the file sizes from the Z88. The file sizes are not displayed by default due to the time it takes to transmit this information.
Display File Date  Selecting this gets the file dates from the Z88. The file dates are not displayed by default due to the time it takes to transmit this information.

Hidden commands

These following commands are in the Z88 and Desktop windows and are selected by using the right-hand mouse button whilst the cursor is in the window.

Z88 Window

 

CommandDevice What do they do? 
Make Dir:RAM Creates a Directory.
Rename:RAM Renames a File.
Delete:RAM Delete File.

Desktop Window

 

Command  What do they do?
Make Dir  Creates a Directory.
Select Drive  Selects an available Drive.
StartUp Dir  Selects the Directory to use when the program is started.
File Size  Moving the mouse over a filename will display the file size in bytes.
This facility can be used to check whether the complete file has been transferred.
Rename  Renames a File.
Delete  Delete File.

 

Transfering Files

There are two methods of transferring files.

  • Using the menus above
  • Drag and Drop

 

 

Drag and Drop

Files may be dragged and dropped between the Z88 and Desktop windows. Files may also be dragged from other program's windows e.g. Windows Explorer into the Z88's window, but not the other way around. When illegal moves are attempted, a 'no waiting' symbol.

 Source Filename Error

 

If the Desktop's filename doesn't comply with the Z88's filename of 12.3 format or uses illegal characters, the user is invited to change the name before the transfer can take place. See 'Specifying Z88 file names in full' for more details.

(Temporary Suggested Menus) - Work in Progress

The idea of this section is to see what the menus would look like if all the commands were there and could be accessed using the keyboard. Commands that are selected using the 2nd button on the mouse remain where they are.

FileZ88Desktop Help What do they do if not obvious? Reason
Why here?
Serial Port   Set which Serial Port the Z88 is connected to.This is the first thing the User need to do.
Eazylink Hello   Issue a Hello command to the Z88Does it work?
Z88 Refresh    Oh it does, better refresh it

 (Settings)
     
StartUp Dir    Although this is a Desktop property, I have put it in settings as it would only be changed occasionally.
Translations     
Actions     
 Select DeVice    
 Select File to Transfer    
 Display File Size    
 Display File Date    
 Create Directory     
 REname File    
 ERase File    
  Select Drive   
  Select File to Transfer   
  Create Directory   
  REname File   
  ERase File   
      
      
    Not sure what the point of this command is because once it is used, all options on the Z88 section are removed. There is no other way of turning it back on again without Exit the program and restarting it again. 
 Send files to Z88 Imp-Export popdown    
 Receive files from Z88 Imp-Export popdown    
Set Z88 Clock    Although these are Z88 functions they have nothing to do with files and are not used often
Read Z88 Clock     
Reload Translation Table     
Get Info   Get information from the Z88 regarding ROM Version number, Devices and Memory. 
   User Guide  
   About  
General (Properties)     
Eazylink Quit   Not sure what the point of this command is because once it is used, all options on the Z88 section are removed. There is no other way of turning it back on again without Exit the program and restarting it again.Command not required?
Exit   Exit the program. 
 12 (13)9 5 2Number of Commands in Column 

 

Imp-Export

This mode's primary role is to allow users to download files so that a copy of the Eazylink popdown can be written to a Flash card or EPROM on the Z88.

It only allows saving and receiving files from the Z88's root Directory.

You should skip this section if you already have a copy of the Z88 Eazylink.

  • Connect Z88 to the Desktop.
  • On the Desktop, start Eazylink2

Get the Z88 Server Popdown

To do it yourself you will need to

  • Download the software.

  • Establish a Serial connection between the Z88 and the Desktop
  • Transfer the software to the Z88 using EazyLink2 Imp-Export mode
  • Run the software on the Z88 to blow the image into an EPROM or Flash card.

Start Eazylink2.

 

The left hand side of the screen is not used with Imp-Export and will be blank. If and when you receive the Reading Z88 Devices Command Failed! Choose 'Ignore.'

On the top menu bar, Select Settings

  • Select Serial Port. Change the 'Default Serial Port:' to the device name the Z88 is connected to.
  • Select General, untick all EazyLink functions and click OK.
  • Select Translations, untick all EazyLink functions and click OK.

Send to the Z88

On the top menu bar, Select Z88

  • Select - Send files to Z88 Imp/Export popdown

If 'Show Details...' is selected, you will be presented with a help screen listing instructions (without the screen shots) on how to use the Z88. 1.

Start Z88

Select Panel []S

Change Default device to :RAM.1 - You will need extra RAM in your Z88 for the file and it needs to be in slot 1. 

Remember to PRESS ENTER TO UPDATE otherwise these settings will not change. 

Note that the Transmit and Receive rates Parity and Xon/Xoff settings are the correct value as given. Scroll down to the next instruction. 2.

Select Imp-Export []X

Scroll down to the next instruction. 3.

Now you can click 'Yes' to 'Is Z88 ready?'

The Desktop will now display a window for you to select which file(s) to send.

 

Receive from Z88

On the top menu bar, Select Z88

  • Select - Receive files from Z88 Imp/Export popdown

 You will now be presented with Select Receive Directory. Create and/or Choose which Directory to use.

 

NOTE: You need to select OK here on the Desktop before starting the Z88. If you get the Imp-Export Receive Command Failed! message, Choose Retry.

If 'Show Details...' is selected, you will be presented with a help screen listing instructions (without the screen shots) on how to use the Z88. 1.

Start Z88

Select Panel []S

Change the Default device to :RAM.1 or where your files are. 

Remember to PRESS ENTER TO UPDATE otherwise these settings will not change. 

Note that the Transmit and Receive rates Parity and Xon/Xoff settings are the correct value as given. Scroll down to the next instruction. 2.

Select Imp-Export []X

NOTE: Before doing the following command you should have started the Desktop command.

Scroll down to the next instruction. 3. On Z88, select (S)end by pressing s and then the Enter key.

You now have two choices

  • Use a wildcard i.e. * to fetch all the files in the root directory, or
  • Fetch the files individually, (making sure the spelling is correct), following the instructions 4) and 5) given in 'Show Details' or Help. 

If you get a communication error, make a note of the messages on the Z88 screen and try again.

If you get continuous communication errors or nothing happens, go to Solving Communication Errors (see below).

Using the Desktop with 2 Z88s

Additional copies of Eazylink2 may be run at the same time, connected to Z88s using different serial ports.

 

 

Specifying Z88 file names in full

 The full form of a file name is

:DEVICE/DIRECTORY/DIRECTORY/ ....

where DIRECTORY and filename are each of the form 

name.extension 

oonsisting of a name of up to 12 letters or digits, followed by an optional extension of up to three letters or digits,

The following extensions are used for system functions:

  
.sgnFor []+K and []+S CLI files.
.CLIFor BOOT.CLI file.
.L

For PipeDream multi-file List file 

DIRECTORY

 

 

is a directory name subject to the same constraints as filename

 

.

 

In addition the following symbols can be used:

 

. I

name Parent directory of

 

 

name 

.

 

Current directory

j

Device  specifications

DEVICE can be specified as one of the following:

SpecificationEffect
:RAM.0

 RAM in slot 0 (internal memory)

:RAM.1

 RAM in slot 1 (external memory)

:RAM.2

 RAM in slot 2 (external memory)

:RAM.3

 RAM in slot 3 (external memory)

:RAM.-

Any RAM memory; ie 0, 1, 2, or 3.
Used by CLI for temporary files, and lost on reset.

:ROM.0

 ROM

:SCR.0Screen
:PRT.0

Printer; via printer driver
so that highlight codes are interpreted

:COM.0

Communications; via serial port

:INP.0

Standard input

:OUT.0

Standard output

:NUL.0

 Null: absorbs output, and acts like an empty file on input

  

Note: RAM. - files must be deleted before a soft reset is performed with Operating Systems up to and including 3.0.

Wildcards

The device, directory and file name can contain the following wildcards:

Wildcard 
*

Matches any number of characters (or none)

?

Matches a single character

//

Matches any number of directories (or none)

  

For example,

 

:*//letter

Finds the file called letter anywhere

doc*

Finds: doc.tx, document, doc27, doc, etc.

* *

Finds only files with extensions.

.. /fred*

Finds all files beginning with fred in the parent directory

Note that the characters '/' and '\' may be used interchangeably.

Problem Solving Area

EazyLink2 and the Z88 should work straight away, but if it doesn't this section will help you to find out why it doesn't.

Resetting the Z88

The Z88 never gets turned off. When the Shift keys are used to turn the display on and off, the Z88 keeps running it its low power mode. Sometimes a fault may appear due to something that was done in the past. So that we can test it at a known state, the Z88 needs to be reset by giving the Z88 a HARD RESET. If you have any important data, make sure that it is saved on either an EPROM or Flash card.

Hard Reset

Do this by opening the card flap, pressing the reset switch 2 times with an unbent paperclip, then shut the card flap.

Select Panel []S

Change Default device to :RAM.1 - You will need extra RAM in your Z88 for the file and it needs to be in slot 1. Move the cursor key down to Default Device, use <> right arrow to move it to the end of the line, DEL the 0 and put in the 1.

Remember to PRESS ENTER TO UPDATE otherwise these settings will not change. 

Select Filer []F

The Filer will still be pointing to ;RAM.0, so this is a good time to point it to RAM.1.

 

Move the left-hand cursor to SELECT DEVICE or use the quick keyboard command, <>SV

Change RAM.0 to :RAM.1 quick keyboard command <>right-arrow DEL 1 ENTER

 

Solving Communication Errors.

Test the Z88 Serial Port

If the Z88's serial port has never been used, it may have never worked.

To test it, you can use a 9 way 'D' plug with pins 2-3 4-5 and 8-9 connected, or you can use a paperclip cut into three to make these three connections.

On the Z88

  • Make the connections as described above.
  • Select the Terminal []V

  • Type some characters on the keyboard like "the quick brown fox jumps over the lazy dog"

  

  • Check that these characters appear on the screen
  • Remove the connections
  • Type some more characters, they should not appear on the screen.

If that all works, the Z88 Serial Port is working.

Is the correct cable being used?

If you are using a standard PC Cable, it will not work. Get the correct cable from Rakewell.

Using a Serial to USB convertor?

have you

  • Downloaded a copy of the latest drivers for your Operating System?
  • Checked that it supports hardware handshaking?

Test the Client's Serial Port

If you are unable to get it working, try downloading a Free Terminal Emulation program for your Client's Operating System and do a similar excercise as described in the "Test the Z88 Serial Port" section.

 

Recent updates

Navigate space

 

  • No labels