Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update firmware download descriptions #551

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions docs/Firmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,26 @@

## Flashen über Web Interface

- download the latest .bin firmware from this repository
### https://github.com/universam1/iSpindel/releases
- download the latest .bin firmware from this repository

<https://github.com/universam1/iSpindel/releases>

- in `Maintenance` menu select this file and press update

![flash web](/pics/maintenance.png)
![flash web](/pics/maintenance.png)

## Flashen über USB
## Flashen über USB (Windows)

- Download und Starten von [NodeMCU-Flasher](https://github.com/nodemcu/nodemcu-flasher/raw/master/Win32/Release/ESP8266Flasher.exe)
- neuestes Release aus [/bin Folder](https://github.com/universam1/iSpindel/raw/master/bin/) downloaden
> Wichtig: ```Download``` button wählen um die Datei korrekt herunterzuladen
- neuestes Release aus [/releases Folder](https://github.com/universam1/iSpindel/releases) downloaden

> Wichtig: `Download` button wählen um die Datei korrekt herunterzuladen

- COM Port den Wemos auswählen
- Tab ```Config``` als erste Datei die ```.bin``` auswählen
- Tab ```Flashen``` klicken, Fortschrittsbalken ist zu sehen
- Nach erfolgreichem Flash ```RESET``` Taste drücken
- Tab `Config` als erste Datei die `.bin` auswählen
- Tab `Flashen` klicken, Fortschrittsbalken ist zu sehen
- Nach erfolgreichem Flash `RESET` Taste drücken

> Evtl. über Serial Monitor (bsp. Arduino IDE) die Statusmeldungen sehen.
> Evtl. über Serial Monitor (bsp. Arduino IDE) die Statusmeldungen sehen.

> Der ```Config Mode``` ist aktiv wenn die LED im 1s Rhythmus blinkt. Man kann ihn beenden über Link im Portal oder über Timeout 5min.
> Der `Config Mode` ist aktiv wenn die LED im 1s Rhythmus blinkt. Man kann ihn beenden über Link im Portal oder über Timeout 5min.
70 changes: 39 additions & 31 deletions docs/Firmware_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,54 +2,62 @@

## Flashing via Web Interface

- download the latest .bin firmware from this repository
### https://github.com/universam1/iSpindel/releases
- download the latest .bin firmware from this repository

<https://github.com/universam1/iSpindel/releases>

- in `Maintenance` menu select this file and press update

![flash web](/pics/maintenance.png)
![flash web](/pics/maintenance.png)

## Flashing via USB (Windows)

- download and run: [NodeMCU-Flasher](https://github.com/nodemcu/nodemcu-flasher/raw/master/Win32/Release/ESP8266Flasher.exe)
- download the latest firmaware Release from the [/bin Folder](https://github.com/universam1/iSpindel/raw/master/bin/)
> Important: select the ```Download``` button to download the file correctly
- download the latest firmware Release from the [/releases Folder](https://github.com/universam1/iSpindel/releases/) Folder

> Important: select the `Download` button to download the file correctly

- Select the COM port for the Wemos
- Use the ```Config``` tab to select the first ```.bin``` file
- Clicking the ```Flashen``` tab shows a progress bar
- After a successful Flash, press the ```RESET``` key
- Use the `Config` tab to select the first `.bin` file
- Clicking the `Flash` button on the `operation` tab shows a progress bar
- After a successful Flash, press the `RESET` key

> ```Config Mode``` is active while the LED is blinking at 1s intervals. It can be exited via the Link in the Portal or by waiting for the 5min timeout.
> `Config Mode` is active while the LED is blinking at 1s intervals. It can be exited via the Link in the Portal or by waiting for the 5min timeout.

## Flashing via USB (Linux)

- download and unpack the latest version of [esptool](https://github.com/igrr/esptool-ck/releases). Then change directory into the newly unpacked directory, using terminal commands such as:
```
wget https://github.com/igrr/esptool-ck/releases/download/0.4.12/esptool-0.4.12-linux64.tar.gz
tar xf esptool-0.4.12-linux64.tar.gz
cd esptool-0.4.12-linux64
```


```bash
wget https://github.com/igrr/esptool-ck/releases/download/0.4.12/esptool-0.4.12-linux64.tar.gz
tar xf esptool-0.4.12-linux64.tar.gz
cd esptool-0.4.12-linux64
```

- download the latest firmware from the [iSpindel Releases page](https://github.com/universam1/iSpindel/releases) e.g.
```
wget https://github.com/universam1/iSpindel/releases/download/5.6.1/firmware.bin
```

- determine the iSpindel's device path. This may be found by listing all serial USB devices before and after plugging in the iSpindel e.g. before iSpinndel is plugged in:
```
ls -l /dev/ttyUSB*
ls: cannot access '/dev/ttyUSB*': No such file or directory
```
```bash
wget https://github.com/universam1/iSpindel/releases/download/7.1.2/firmware.bin
```

now after iSpindel is plugged in:
```
ls -l /dev/ttyUSB*
crw-rw-rw- 1 root dialout 188, 0 Dec 11 23:20 /dev/ttyUSB0
```
showing that the iSpindel device name is /dev/ttyUSB0
- determine the iSpindel's device path. This may be found by listing all serial USB devices before and after plugging in the iSpindel e.g. before iSpindel is plugged in:

```bash
ls -l /dev/ttyUSB*
ls: cannot access '/dev/ttyUSB*': No such file or directory
```

- upload the firmware by running the esptool command with the discovered iSpindel device name (/dev/ttyUSB0 in this case):
now after iSpindel is plugged in:

```bash
ls -l /dev/ttyUSB*
crw-rw-rw- 1 root dialout 188, 0 Dec 11 23:20 /dev/ttyUSB0
```

```./esptool -vv -cd nodemcu -cb 921600 -cp /dev/ttyUSB0 -ca 0x00000 -cf ./firmware.bin```
showing that the iSpindel device name is /dev/ttyUSB0

- upload the firmware by running the esptool command with the discovered iSpindel device name (/dev/ttyUSB0 in this case):

```bash
./esptool -vv -cd nodemcu -cb 921600 -cp /dev/ttyUSB0 -ca 0x00000 -cf ./firmware.bin
```
67 changes: 38 additions & 29 deletions docs/Firmware_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,52 +2,61 @@

## 通过 网页接口 刷入

- 从项目仓库里下载最新的 .bin 固件
### https://github.com/universam1/iSpindel/releases
- 从项目仓库里下载最新的 .bin 固件

<https://github.com/universam1/iSpindel/releases>

- 在 `Maintenance` 一项里选择固件文件并按更新

![flash web](/pics/maintenance.png)
![flash web](/pics/maintenance.png)

## 通过 USB 刷入 (Windows)

- 下载并运行:[NodeMCU-Flasher](https://github.com/nodemcu/nodemcu-flasher/raw/master/Win32 从 [/bin 路径文件夹](https://github.com/universam1/iSpindel/raw/master/bin/)
> 重要提示:选择 “下载” 按钮以正确下载文件
- 下载并运行:[NodeMCU-Flasher](https://github.com/nodemcu/nodemcu-flasher/raw/master/Win32 从 [/releases 路径文件夹](https://github.com/universam1/iSpindel/releases)

> 重要提示:选择 “下载” 按钮以正确下载文件

- 选择 Wemos 的 COM 端口
- 使用 ```Config``` 选项 悬着第一个 ```.bin``` 固件
- 点击 ```Flashen``` 选项显示进度条
- 刷入固件后, 点击 ```RESET``` 重置键
- 使用 `Config` 选项 悬着第一个 `.bin` 固件
- 点击 `Flash` 选项显示进度条
- 刷入固件后, 点击 `RESET` 重置键

> 当 LED 灯以 1 秒的间隔闪烁时,```配置模式``` 会处于激活状态,可以通过退出设置模式或等待五分钟超时来退出该模式。
> 当 LED 灯以 1 秒的间隔闪烁时,`配置模式` 会处于激活状态,可以通过退出设置模式或等待五分钟超时来退出该模式。

## 通过 USB 刷入 (Linux)

- 下载并解压最新版本的 [esptool](https://github.com/igrr/esptool-ck/releases),然后使用终端命令将目录更改为新解压的目录,示例:
```
wget https://github.com/igrr/esptool-ck/releases/download/0.4.12/esptool-0.4.12-linux64.tar.gz
tar xf esptool-0.4.12-linux64.tar.gz
cd esptool-0.4.12-linux64
```


```bash
wget https://github.com/igrr/esptool-ck/releases/download/0.4.12/esptool-0.4.12-linux64.tar.gz
tar xf esptool-0.4.12-linux64.tar.gz
cd esptool-0.4.12-linux64
```

- 从 [iSpindel Releases page](https://github.com/universam1/iSpindel/releases) 下载最新的固件,例如:
```
wget https://github.com/universam1/iSpindel/releases/download/5.6.1/firmware.bin
```

```bash
wget https://github.com/universam1/iSpindel/releases/download/7.1.2/firmware.bin
```

- 确定设备 iSpindel 的路径,这可以通过列出插入 iSpindel 前后的所有串行 USB 设备找到,比如可能在 iSpindel 插入之前。
```
ls -l /dev/ttyUSB*
ls: cannot access '/dev/ttyUSB*': No such file or directory
```

在 iSpindel 插入之后:
```
ls -l /dev/ttyUSB*
crw-rw-rw- 1 root dialout 188, 0 Dec 11 23:20 /dev/ttyUSB0
```
上面显示 iSpindel 设备名称是 /dev/ttyUSB0
```bash
ls -l /dev/ttyUSB*
ls: cannot access '/dev/ttyUSB*': No such file or directory
```

在 iSpindel 插入之后:

```bash
ls -l /dev/ttyUSB*
crw-rw-rw- 1 root dialout 188, 0 Dec 11 23:20 /dev/ttyUSB0
```

上面显示 iSpindel 设备名称是 /dev/ttyUSB0

- 用找到的 iSpindel 设备名称 (在这个例子是 /dev/ttyUSB0) 通过运行 esptool 指令来上传固件:

```./esptool -vv -cd nodemcu -cb 921600 -cp /dev/ttyUSB0 -ca 0x00000 -cf ./firmware.bin```
```bash
./esptool -vv -cd nodemcu -cb 921600 -cp /dev/ttyUSB0 -ca 0x00000 -cf ./firmware.bin
```