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

Docs improved #231

Merged
merged 8 commits into from
Oct 15, 2024
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
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ Module.symvers
Mkfile.old
dkms.conf

# docs
docs/.nuxt
docs/node_modules

#Vehicle Profiles
.vehicle_profiles/node_modules/
.vscode/
Expand Down
19 changes: 19 additions & 0 deletions docs/content/0.Config/1.WiFi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Configuring WiFi

## Access point mode
By default your WiCAN will act as Access Point and create its own WiFi network named `WiCAN_xxxxxxx`. You can connect to it with the default password `@meatpi#`.

If you are using a phone, you may need to wait a few seconds and confirm you want to connect to a network that does not provide internet.

Once connected you can open `http://192.168.80.1` in your browser to access the user interface of the WiCAN.

![image](/config/wifi/accesspoint.png)

It is probably a good idea to change the Access point password in the user interface on the "Settings" tab. Otherwise anyone can connect to your WiCAN if he can get close to your car while the WiCAN is powered on.

## Connect WiCAN to your home WiFi network
In the user interface of the WiCAN go to the `Settings` tab to change `Mode` to `AP+Station`, and input the `SSID` and `Password` of your home WiFi network and press the `Submit changes` button.

Once saved you can check the "Status" tab to see the `Station IP` address assigned by your home WiFi access point. Once you have the station IP address you can access the user interface of the WiCAN by using this IP address from your web browser.

![image](/config/wifi/wifi_config.png)
File renamed without changes.
29 changes: 29 additions & 0 deletions docs/content/0.Config/3.Firmware-Update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Firmware Update

For firmware version v1.00 method "USB flash" has to be used.

**NOTE: During flashing, the device configuration might be erased. Make notes/screenhots of configuration before if needed!**

## 1. OTA:
1. [Go to the latest release page](https://github.com/meatpiHQ/wican-fw/releases/latest) and check the update instructions. This page also list new features and bug fixes provided by this version.
1. Download the file `wican-fw_vXXX_obd.zip` (where XXX indicates the release version).
1. Extract the ZIP file to any directory.
1. Open the WiCAN web interface
1. Click on the "About" tab.
1. Click on "Choose File".
1. Select the file name `wican-fw_obd_vXXX.bin` (where XXX indicates the release version) in the directory where you extracted the ZIP file to. The file you selected should be shown like this: ![image](/config/firmware/firmware_selected.png)
1. Click `Update`
1. During the update the message "Updating pleae wait ..." will be displayed. The update should take about 30sec. ![image](/config/firmware/firmware_updating.png)
1. Once the update has finished WiCAN will show the "Status" tab again. You should switch to "About" tab and check the `Firmware version`. It should display the release version you have just flashed.

## 2. USB Flash:
1. [Go to the latest release page](https://github.com/meatpiHQ/wican-fw/releases/latest) and check the update instructions. This page also list new features and bug fixes provided by this version.
1. Download the file `wican-fw_vXXX_usb.zip` where XXX indicates the release version.
1. Download [**ESP flash tool**](https://www.espressif.com/en/support/download/other-tools).
1. Use the same settings as in the picture below and press `OK` ![image](/config/firmware/flash-select.png)
1. Set the configuration as the picture below, select and fill in the address for each binary. ![image](/config/firmware/flash-config.png)
1. Short the pins as shown, then plug in the USB cable.
- OBD ![image](/config/firmware/obd.png)
- USB ![image](/config/firmware/usb.png)
1. After you plug in the USB cable the Orange LED will light up. Now click `START` button on the flash tool.

42 changes: 0 additions & 42 deletions docs/content/0.Config/Firmware-Update.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/content/0.Config/WiFi.md

This file was deleted.

Loading