浏览代码

Fixed the readme

Per Mårtensson 11 小时之前
父节点
当前提交
f710175b55
共有 1 个文件被更改,包括 112 次插入33 次删除
  1. 112 33
      README.md

+ 112 - 33
README.md

@@ -1,5 +1,6 @@
-# OpenFlops
-OpenFlops is an Open Hardware Floppy Disk Drive emulator/simulator.
+# SweFlopsMini8
+SweFlopsMini8 is an Open Hardware Floppy Disk Drive emulator/simulator.
+It was based on OpenFlops but nothing there remains
 
 ![Board](https://git.sweproj.com/ABC80/SweFlopsMini8/raw/master/doc/sweflopsmini8.png)
 
@@ -25,21 +26,109 @@ SweFlops is an Open Hardware implementation of such an emulator, inspired from t
 
 All of this comes in the same form factor (and mounting holes) as the board installed in the original Gotek, hence it can be easily installed in any shell or enclosure designed for it.
 
-### Assembly and Installation
-Solder all components to the board. I suggest starting with the main microcontroller (U3), as it uses an LQFP package which is tricky to solder: the recommended technique is drag soldering, there are many videos about that on YouTube, so please look there for advice. I recommend soldering the bare minimum components needed for programming and then trying to flash it right away. This way you will be able to fix your soldering without too many components getting in the way, if needed. You will need a USB/TTL Serial converter for this: one with 3.3V I/O level is recommended, but a 5V one can be used, too (most pins on STM32 microcontrollers are 5V-tolerant, so don't worry, it's not a bad hack!). You shouldn't pay more than 1-2€ for it in any case, anyway. So, when you are ready:
+# SweFlopsMini8
 
-- Solder U3, Y1, C3 and C5, then the programming header (the top one with power, BOOT0, TX, RX, etc.)
-- Check for shorts on the 3.3V power lines, you can easily do this on the pads for C6-C10
-- If your USB/Serial adapter has a 3.3V output, connect it to 3.3V on the power header, then connect ground, RX and TX
-- If no 3.3V output is available, solder U4 and power the board through the 5V pin on the power header
+**A modern Gotek replacement with WiFi, embedded storage, and dual-drive emulation support.**
 
-Now you should be able to [program the STM32 microcontroller](https://github.com/keirf/FlashFloppy/wiki/Firmware-Programming). If you have difficultes you can try adding R10 (and C4) and maybe a few of C6-C10, but most likely the problem will be with the solder joints on U3, as soldering this kind of package manually is never easy, so please get a lens (or even better, a microscope) and double-check your job.
+**First Boot WiFi Setup:**
+After the first boot, the device will start as a WiFi access point. You can connect to this access point to configure your own SSID and password (PSK) for your network.
 
-The serial adapter is only necessary for the first flashing. Subsequent updates [can be done easily via USB](https://github.com/keirf/FlashFloppy/wiki/Firmware-Update).
+Follow the on-screen instructions in the configuration portal to complete the setup.
+
+### Connecting via FTP
+
+The board also runs an FTP server for file management.
+
+- **FTP Port:** 21 (default)
+- **Username:** gotek
+- **Password:** gotek
+
+**How to connect:**
+1. Ensure the board is powered and connected to your network.
+2. Use any FTP client (e.g., FileZilla, WinSCP) to connect to the board's IP address on port 21.
+3. Log in with the provided credentials.
+4. You can upload, download, and manage disk images stored on the internal NAND flash or USB connector.
+
+
+### Connecting via WebDAV
+
+The board runs a WebDAV server on port **8080** (default). You can connect to it using any WebDAV client.
+
+- **URL format:**  
+	`http://<device-ip>:8080/`
+
+Replace `<device-ip>` with the actual IP address assigned to your board. Be sure to include `:8080` in the URL to specify the port.
+
+Replace `<device-ip>` with the actual IP address assigned to your board.
+
+**How to connect:**
+1. Ensure the board is powered and connected to your network.
+2. Use a WebDAV client (e.g., Windows Explorer, Cyberduck, or `curl`) to connect to `http://<device-ip>:8080/`.
+3. You can browse, upload, and manage disk images stored on the internal NAND flash or USB connector.
+
+### Web GUI and OSD Information
+
+The device provides a web-based GUI on port **80**. This interface displays information that would normally appear on the OSD, directly on the webpage.
+
+- **URL:**  
+	`http://<device-ip>/`
+
+Replace `<device-ip>` with the actual IP address assigned to your board.
+
+**How to connect:**
+1. Ensure the board is powered and connected to your network.
+2. Open a web browser and navigate to `http://<device-ip>/` to access the web GUI and view OSD information.
+
+**Note:**
+To upload or download files from the internal flash, you must disable the STM32 using a switch in the web UI. This ensures safe access to the storage.
+
+
+A simple gotek replacement with WiFi and embedded storage.
+
+Disk images can be stored and used from either the internal NAND flash or via the USB connector.
+
+**Note:** The board is prepared for emulation of two drives, a feature not yet implemented in FlashFloppy.
+
+### OTA Firmware Update
+
+The board supports OTA (Over-The-Air) firmware updates via a web interface.
+
+- **URL format:**  
+	`http://<device-ip>/webota`
+
+Replace `<device-ip>` with the actual IP address assigned to your board.
+
+**How to update:**
+1. Ensure the board is powered and connected to your network.
+2. Open a web browser and navigate to `http://<device-ip>/webota`.
+3. Follow the on-screen instructions to upload and flash new firmware.
+
+## Getting Started: Flashing and Powering the Board
+
+### 1. Flashing the ESP32
+
+Before you can flash the STM32, you must first flash the ESP32. This is required for proper board initialization and communication.
+
+**Steps:**
+1. Connect the board to your computer using the USB-C port.
+2. The ESP32 must be flashed via the serial port **P11**.
+3. Use your preferred flashing tool (e.g., PlatformIO, esptool) to upload the firmware to the ESP32.
+4. Ensure the ESP32 boots and runs correctly before proceeding.
+
+### 2. Flashing the STM32
+
+Once the ESP32 is up and running, you can flash the STM32 using your chosen method (e.g., ST-Link, etc.).
+
+**Note:** The STM32 may rely on the ESP32 for certain board functions, so flashing order is important.
+
+#### Flashing FlashFloppy to STM32
+
+To flash FlashFloppy firmware to the STM32, follow the official instructions and documentation:
+https://github.com/keirf/FlashFloppy/wiki/Firmware-Programming
+
+The serial adapter is only necessary for the first flashing. Subsequent updates [can be done easily via USB]
 
 Note that most components are necessary, but there are a few you can skip if you are feeling lazy:
-- If you are not interested in the head movement sound, you can skip the following components: SPK1, D2, R5, R6, Q7.
-- If your LCD/OLED display already has pull-up resistors for the SDA/SCK lines (most do), you can skip R3 and R4.
 
 ### Configuration
 Please refer to the FlashFloppy wiki for the [initial setup](https://github.com/keirf/FlashFloppy/wiki/Initial-Setup) and an overview of the [available configuration options](https://github.com/keirf/FlashFloppy/wiki/FF.CFG-Configuration-File).
@@ -49,10 +138,15 @@ Some options that you will want to override the default values of, in order to t
 - `rotary`
 - `display-type`
 
-### Releases
-If you want to get this board produced, you are recommended to get [the latest release](https://github.com/SukkoPera/OpenFlops/releases) rather than the current git version, as the latter might be under development and is not guaranteed to be working.
+### 3. USB-C Port Usage
+
+	- **Debugging:** Connect to your computer for serial output and firmware flashing.
+	- **Power Source:** The board is powered via the USB-C connection or the power headers.
+
+**Tip:** Always ensure a stable USB-C connection for reliable flashing and debugging.
 
-Every release is accompanied by its Bill Of Materials (BOM) file and any relevant notes about it, which you are recommended to read carefully.
+    - **To get it running please flash the ESP32S3 first!!!
+    - **The STM32 will be hold in reset mode until the ESP32S3 is operational
 
 ### License
 The OpenFlops documentation, including the design itself, is copyright &copy; SukkoPera 2019-2020.
@@ -70,26 +164,11 @@ Any modifications made by Licensees (see section 3.4.b) shall be recorded in fil
 The Documentation Location of the original project is https://github.com/SukkoPera/OpenFlops/.
 
 ### Support the Project
-Since the project is open you are free to get the PCBs made by your preferred manufacturer, however in case you want to support the development, you can order them from PCBWay through this link:
-
-[![PCB from PCBWay](https://www.pcbway.com/project/img/images/frompcbway.png)](https://www.pcbway.com/project/shareproject/OpenFlops_V1.html)
-
-You get my gratitude and cheap, professionally-made and good quality PCBs, I get some credit that will help with this and [other projects](https://www.pcbway.com/project/member/shareproject/?bmbid=41100). You won't even have to worry about the various PCB options, it's all pre-configured for you!
-
-Also, if you still have to register to that site, [you can use this link](https://www.pcbway.com/setinvite.aspx?inviteid=41100) to get some bonus initial credit (and yield me some more).
-
-Again, if you want to use another manufacturer, feel free to, don't feel obligated :). But then you can buy me a coffee if you want:
-
-<a href='https://ko-fi.com/L3L0U18L' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi2.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
-
-### Get Help
-If you need help or have questions, you can join [the official Telegram group](https://t.me/joinchat/HUHdWBC9J9JnYIrvTYfZmg).
+Not sure howto but if you really want you will find away to contact me
 
 ### Thanks
 - H.M for publishing the [original Gotek schematics](doc/gotek_usb-fde_block-diagram.jpg)
 - [keirf](https://github.com/keirf) for FlashFloppy
-- Brian Allan for suggesting some improvements for the Speaker circuit
-- Ray Bellis for suggesting adding pin headers for the USB port and speaker
-- Mario Babeu for suggesting to line up the orientation of LD1 and LD2
-- Patrick Kerkhof for sending me a lot of original Gotek housing for dimensional testing
+
+