falso
/
zxuno-git
mirror of https://github.com/zxdos/zxuno.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

revised English translation

This commit is contained in:
Andrew Owen 2023-08-27 12:23:35 +01:00
parent aaf5f610a0
commit 054ad98b91
2 changed files with 722 additions and 629 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1244
doc/src/English ZXTRES Manual.adoc
View File

File diff suppressed because it is too large Load Diff

107
doc/src/miniduino_en.adoc
View File

@ -1,6 +1,6 @@
https://www.antoniovillena.es/store/product/miniduino/[Miniduino] is a tape file audio player, based on a STM32F103C8T6 microcontroller or ATMega38P, and https://github.com/rcmolina/MaxDuino_BETA[Maxduino] firmware preinstalled.
https://www.antoniovillena.es/store/product/miniduino/[Miniduino] is a tape file audio player, based on an STM32F103C8T6 microcontroller or ATMega38P with the https://github.com/rcmolina/MaxDuino_BETA[Maxduino] firmware preinstalled.
Maxduino plays, in a very similar way to how https://es.wikipedia.org/wiki/Casete[cassette tape] players worked, digital tape files in format as like `TAP` and `TZX` (ZX Spectrum), `O` (ZX80), `P` (ZX81), `CDT` (Amstrad CPC), `CAS`(MSX) `TSX` (MSX, Acorn, etc). It is also possible to play AY music files as if they were tapes, in order to load the from http://www.specay.co.uk[SpecAY] in a ZX Spectrum.
Maxduino works in a similar way to https://es.wikipedia.org/wiki/Casete[cassette tape] players, using digital tape files formats such as `TAP` and `TZX` (ZX Spectrum), `O` (ZX80), `P` (ZX81), `CDT` (Amstrad CPC), `CAS`(MSX) `TSX` (MSX, Acorn, etc). It's also possible to play AY music files as if they were tapes, to load them from http://www.specay.co.uk[SpecAY] in a ZX Spectrum.
== Ports and buttons
@ -30,69 +30,69 @@ image:img/MiniduinoFront.jpg[scaledwidth=50%]
== Configuration
A SD is needed in order to store the tape files to play. Fast cards (Class 10 or greater) aren't recommended because there can be problems while reading the data. High capacity (SDXC or greater) cards aren't recommended too.
An SD card is required to store the tape files to play. Fast cards (Class 10 or greater) aren't recommended because there can be problems while reading the data. High capacity (SDXC or greater) cards aren't recommended either.
The card must have the first partition formatted as FAT16 or FAT32.
The SD card must have the first partition formatted as FAT16 or FAT32.
Besides the card, you have to plug an appropriate audio cable to <<#_ports_and_connectors,audio input>>. It must have a 3.5 mm stereo jack on one side, and two mono output on the other side (one for each audio channel). The right audio mono is connected to the Miniduino.
Besides the card, you must connect an appropriate audio cable to <<#_ports_and_connectors,audio input>>. It must have a 3.5mm stereo jack on one side, and two mono output on the other side (one for each audio channel). The right audio mono is connected to the Miniduino.
If you have a device that can use motor control, you can also use a cable with a 2.6 mm jack.
If you have a device that can use motor control, you can also use a cable with a 2.6mm jack.
Copy the tape files (`TAP`, `TZX`, `O`, `P`, `CAS`, `TSX`, etc) to the first partition of the SD card. They can be organized using folders or directories.
Copy the tape files (`TAP`, `TZX`, `O`, `P`, `CAS`, `TSX` and so on) to the first partition of the SD card. They can be organised using folders or directories.
[TIP]
====
The player shows file and directory entries in the order stored in the internal FAT table, and not alphabetically. If you want to see them ordered, you have to reorder the SD card structure with a utility like Fat Sorter for Windows, https://fatsort.sourceforge.io/[FATsort] for Linux and MacOS, https://www.luisrios.eti.br/public/en_us/projects/yafs/[YAFS], http://www.trustfm.net/software/utilities/SDSorter.phpp[SDSorter] or other.
The player shows file and folder entries in the order stored in the internal FAT table, not alphabetically. If you want to see them ordered you must reorder the SD card structure with a utility such as https://fatsort.sourceforge.io/[FATsort], https://www.luisrios.eti.br/public/en_us/projects/yafs/[YAFS], http://www.trustfm.net/software/utilities/SDSorter.phpp[SDSorter] or another application.
====
<<<
== Use
Once the SD card with the data files is inserted, it's turned on plugging in the included USB power cable.
After the SD card with the data files is inserted, power it on by connecting the included USB power cable.
[.text-center]
image:img/MiniduinoLogo.jpg[scaledwidth=30%]
Pressing down the control button shows the options menu which can set the following:
To show the optional menu, hold down the control button:
- Baud Rate: Configures turbo speed baud rates when playing 4B blocks in MSX files (`CAS` and `TSX`)
- Motor Ctrl: Enable this option when a control cable is connected to a proper device (Amstrad, CPC, MSX, etc.)
- Converter (TSXCzxpUEFWS): Enables turbo loading `.CAS` and `.TSX` files, changes signal for Spectrum and Amstrad CPC files and/or change parity when playing Acorn Electron and BBC Micro `.UEF` files
- (Skip BLK)): To disable (Skip ON) or enable automatic pause when 2A blocks are found
- Baud Rate: Configures turbo speed baud rates when playing 4B blocks in MSX files (`CAS` and `TSX`).
- Motor Ctrl: Enable this option when a control cable is connected to a proper device (Amstrad, CPC, MSX and so on).
- Converter (TSXCzxpUEFWS): Enables turbo loading `CAS` and `TSX` files, changes signal for Spectrum and Amstrad CPC files or change parity when playing Acorn Electron and BBC Micro `UEF` files.
- (Skip BLK)): To switch off (Skip ON) or enable an automatic pause when 2A blocks are found.
When not inside the options menu, the control button is used as a four directional control joystick, which has two different behaviours depending whether the player is stopped or paused.
Outside the options menu, the control button is used as a four directional control joystick that has two different behaviours depending on whether the player is stopped or paused.
[.text-center]
image:img/MiniduinoVersion.jpg[scaledwidth=30%]
When the player is stopped (file and directories browser):
- Up and Down move through the current files and directories list
- Left (Stop) goes one level up in the directory tree
- Right (Play/Pause) enters into a directory or, if the selection is a file, tries to play it
- Up and Down move through the current files and folders list.
- Left (Stop) goes one level up in the folder tree.
- Right (Play/Pause) enters a folder or, if the selection is a file, tries to play it.
<<<
Once a file is being played, stop playing it with the left button (Stop) or pause using the right button (Play/Pause).
When a file is playing you can stop it with the left button (Stop) or pause using the right button (Play/Pause).
[.text-center]
image:img/MiniduinoPlay.jpg[scaledwidth=30%]
When in pause (tape block browser:
- Up and Down mov through the tape block files already played (useful for multiload titles, to load a previous level block, for example)
- Left (Stop) cancels the player and goes back to file and directory browser mode
- Right (Play/Pause) continues playing from the selected block
- Press down the control button to enable or disable turbo mode for MSX
- Up and Down move through the tape block files already played (useful for multiload titles or to load a previous level block).
- Left (Stop) cancels the player and goes back to file and folder browser mode.
- Right (Play/Pause) continues playing from the selected block.
- Press down the control button to enable or disable turbo mode for MSX.
== Making TZX or TSX files from other formats
While there are same tape file formats (Commodore, Camputers Lynx, etc.) not supported by Maxduino, there are some programs that can, more or less successfully, embed <<#_audio_file_conversion,audio data>> in a `TSX` or `TZX` file, which then can be used with Miniduino.
While some tape file formats (Commodore, Camputers Lynx and so on) are not supported by Maxduino, there are some utilities that can, more or less successfully, embed <<#_audio_file_conversion,audio data>> in a `TSX` or `TZX` file, which then can be used with Miniduino.
=== MakeTSX
You can use the following command with NataliaPC's https://github.com/nataliapc/makeTSX/releases[MakeTSX] to create a `TSX` file with embedded audio:
You can use this command with NataliaPC's https://github.com/nataliapc/makeTSX/releases[MakeTSX] to create a `TSX` file with embedded audio:
[source,shell]
----
@ -101,7 +101,7 @@ You can use the following command with NataliaPC's https://github.com/nataliapc/
=== RetroConverter
Jorge Fuertes https://github.com/jorgefuertes/retroconverter/releases[RetroConverter] can create a `TZX` file with a command like this:
Jorge Fuertes' https://github.com/jorgefuertes/retroconverter/releases[RetroConverter] can create a `TZX` file:
[source,shell]
----
@ -112,9 +112,9 @@ Jorge Fuertes https://github.com/jorgefuertes/retroconverter/releases[RetroConve
== Maxduino firmware upgrade
Maxduino firmware is periodically updated and improved. You can track the changes and improvements either at the https://www.va-de-retro.com/foros/viewtopic.php?t=5541&start=9999[Va de Retro forums] or at the https://github.com/rcmolina/MaxDuino_BETA[GitHub project page]. To take advantage of this improvements, the Miniduino flash image must be flashed with the updated firmware version.
The Maxduino firmware is periodically updated and improved. You can track the changes and improvements either at the https://www.va-de-retro.com/foros/viewtopic.php?t=5541&start=9999[Va de Retro forums] or at the https://github.com/rcmolina/MaxDuino_BETA[GitHub project page]. To take advantage of this improvements, the Miniduino flash image must be flashed with the updated firmware version.
There are two Miniduino models, one based on STM32 microcontroller, and another one based on ATMega328P.
There are two Miniduino models; one based on the STM32 microcontroller and the ther on the ATMega328P.
<<<
@ -122,24 +122,23 @@ There are two Miniduino models, one based on STM32 microcontroller, and another
==== Environment setup
Firmware flashing is done from a computer (Windows, Mac, Linux) with https://www.arduino.cc/en/software[Arduino IDE] installed.
Firmware flashing is done from a computer (Windows, macOS or Linux) with https://www.arduino.cc/en/software[Arduino IDE] installed.
You have to install SDFat (1.1.4) software library selecting the menu option Program -> include library -> manage libraries
You must install SDFat (1.1.4) software library selecting the menu option Program -> include library -> manage libraries.
Minidiuno microcontroller support must also be added. This is done in two steps:
First, adding ARM Cortex M3 support from menu Tools -> board -> board manager, and installing "Arduino SAM boards (Cortex-M3)"
. Add ARM Cortex M3 support from menu Tools -> board -> board manager, and installing "Arduino SAM boards (Cortex-M3)".
. Add STM32 microcontroller support; download the file available at https://github.com/rogerclarkmelbourne/Arduino_STM32/archive/master.zip[this link].
Then, you have to add STM32 microcontroller support, downloading the file available at https://github.com/rogerclarkmelbourne/Arduino_STM32/archive/master.zip[this link].
Extract the contents to the current user directory in
Extract the contents to the current user folder in:
[source,shell]
----
...Arduino/hardware/Arduino_STM32
----
If on Windows, install the USB device controller, running (with elevated privileges:
On Windows, install the USB device controller running (with elevated privileges:
[source,shell]
----
@ -153,11 +152,11 @@ On Linux, install with root privileges the necessary `udev` rules:
...tools/linux/install.sh
----
On MacOS, if Miniduino does not appear as USB device in Arduino ID when plugged, it may be necessary to install https://github.com/libusb/libusb/wiki[libusb].
On macOS, if Miniduino doesn't appear as a USB device in Arduino ID when connected it may be necessary to install https://github.com/libusb/libusb/wiki[libusb].
<<<
Finally, when on Mac or Linux, the file `maple_upload` inside `Arduino_STM32` has to be changed with a text editor. Those lines do not work:
Last, on Mac or Linux, the file `maple_upload` inside `Arduino_STM32` must be edited with a text editor. Those lines do not work:
[source,shell]
----
@ -168,7 +167,7 @@ else
fi
----
And they have to be changed into this:
They must be changed to:
[source,shell]
----
@ -179,16 +178,16 @@ dfuse_addr=""
==== Upgrade
Once you have the environment ready, download the software from the https://github.com/rcmolina/MaxDuino_BETA[official repository in GitHub]
After the environment is ready, download the software from the https://github.com/rcmolina/MaxDuino_BETA[official repository in GitHub].
[NOTE]
====
Miniduino player with STM32 microcontroller is only supported from 1.65 and up
The Miniduino player with STM32 microcontroller is only supported from version 1.65 and up.
====
Load the project file with Arduino IDE (for example `MaxDuino_v1.69.ino`).
Check in the file `userSTM32Config.h` that all logo entries are commented except for Miniduino and, if not, change them.
Ensure that all logo entries in `userSTM32Config.h` file are commented out except for Miniduino.
[source,c]
----
@ -202,21 +201,21 @@ Check in the file `userSTM32Config.h` that all logo entries are commented except
...
----
Connect the Miniduino device to the computer using the USB cable, and find the assigned port, normally with a name like "Maple Mini" (for example: COM5 Maple Mini)
Connect the Miniduino device to the computer using the USB cable, and find the assigned port, typically called something like "Maple Mini" (for example: COM5 Maple Mini)
Set the following options in the "Tools" menu:
Fom the "Tools" menu set these options:
[source]
----
Board: Generic STM32F103C Series
Variant: STM32F103C8 (20k RAM, 64k Flash)
Upload Method: STM32duino bootloader
CPU Speed: 72Mhz (Normal)
Optimize: Smallest (default)
Port: <Previously identified port>
Board: Generic STM32F103C Series.
Variant: STM32F103C8 (20k RAM, 64k Flash).
Upload Method: STM32duino bootloader.
CPU Speed: 72Mhz (Normal).
Optimize: Smallest (default).
Port: <Previously identified port>.
----
Finally, click on the firmware load button and wait for a few seconds while the project is compiled and loaded into the device.
Last, click on the firmware load button and wait for a few seconds while the project is compiled and loaded into the device.
If everything has been done correctly the Miniduino will restart and show on the screen the new firmware version.
@ -238,11 +237,11 @@ image:img/usbasp.jpg[scaledwidth=40%]
Also, firmware flashing is done from a computer (Windows, Mac, Linux) with https://www.arduino.cc/en/software[Arduino IDE] installed.
You have to install SDFat (1.1.4) software library selecting the menu option Program -> include library -> manage libraries.
You must install SDFat (1.1.4) software library selecting the menu option Program -> include library -> manage libraries.
==== Upgrade
Once you have the environment ready, download the software from the https://github.com/rcmolina/MaxDuino_BETA[official repository in GitHub]
After you have the environment ready, download the software from the https://github.com/rcmolina/MaxDuino_BETA[official repository in GitHub]
Load the project file with Arduino IDE (for example `MaxDuino_v1.69.ino`).
@ -278,6 +277,6 @@ Processor: ATmega328P (5V,16 Mhz)
Programmer: "USBasp"
----
Finally, keep pressed the computer keyboard Shift key while clicking on the firmware load button and wait for a few seconds until the project is compiled and loaded into the device.
Last, hold down the 'Shift' key on the computer while clicking the firmware load button. Wait for a few seconds until the project is compiled and loaded into the device.
If everything has been done correctly the Miniduino will restart and show on the screen the new firmware version.
If everything was done correctly the Miniduino will restart and show on the screen the new firmware version.