Forráskód Böngészése

Changed the readme

Per Mårtensson 6 órája
szülő
commit
c14c6e76d6
1 módosított fájl, 111 hozzáadás és 1 törlés
  1. 111 1
      sw/SweFlops/README.md

+ 111 - 1
sw/SweFlops/README.md

@@ -1 +1,111 @@
-# Alternative BTT TF Cloud V1.0 Firmware (AFW)
+# SweFlopsMini8
+
+**A modern Gotek replacement with WiFi, embedded storage, and dual-drive emulation support.**
+
+**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.
+
+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:
+
+
+### 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.
+
+    - **To get it running please flash the ESP32S3 first!!!
+    - **The STM32 will be hold in reset mode until the ESP32S3 is operational
+
+