www.meatpi.com

Please update to the latest firmware version

Order on Crowd Supply!

webCAN Comming soon!

---

WiCAN-USB Pinout

WiCAN-OBD2 Pinout

---

• Features Wishlist

• Important Notes

• Build

• Description

• Features

  • Sleep mode
  • Battery Alert

• Configuration

  • WiFi/CAN Configuration
  • BUSMaster
  • Realdash
  • SavvyCAN
  • webCAN

• SocketCAN

  • WiFi
  • USB

• ELM327 OBD2 Protocol

• MQTT

  • Status
  • Receive Frames
  • Transmit Frames

• Home Assistant

• Firmware Update

  • OTA
  • USB Flash

Features Wishlist:

• CAN Auto baudrate DONE
• Support ELM327 OBD2 protocol DONE (Basic support)
• Home Assistant Integrations
• Extended ELM327 support
• Support ELM327 protocol and Realdash protocol simultaneously on WiFi and BLE
• Add option to send an Email on battery alert
• Expand alerts to include other CAN parameters parsed from DBC files.

Important Notes:

• The OBD2 adapter is not designed to powered of the USB connecter. The USB connector can power the adapter to flash custom firmware or hardreset the deivce and can also be used for debuging.
• It is highly recommanded to turn OFF the BLE if not used. Otherwise it might affect the preformance.
• When the BLE is connected, the device configuration access point will be disabled i.e you won't be able to configure the device unless you disconnect the BLE, by turning off the BLE on your phone or device.

Build:

1. Install ESP-IDF v4.4.
2. Clone porject.
3. Open project and build.

Description:

WiCAN is a OBD-II WiFi/BLE to CAN adapter based on ESP32-C3, it is the great tool for car hacking. The original firmware can interface directly with RealDash over WiFI or BLE. Realdash allows you to create your own custom dashboard with stunning graphics, it's available on ANDROID, IOS AND WINDOWS 10.It can connect to your existing WiFi network or any device can connect to it's WiFi access point.

WiCAN also works with BUSMaster, for monitoring and logging CAN bus traffic.

Also available API for LabView, C#, VB.Net, Delphi, Python - In case you're writing your own software.

WiFi and CAN configuration can be set configuration web server.

Programming Examples

Features and Specifications:

• Supports CAN2.0A/B up to 1Mbits.
• Works with Realdash, based on "realdash 66"
• Supports SocketCAN and works with BUSMaster
• Supports TCP and UDP
• WiFi can be used in AP and station mode
• WiFi and CAN configured using web interface.
• Diode protection for the USB port

Features:

---

1. Sleep Mode:

WiCAN can be permanently attached to the car without worrying about draining the battery. It monitors the battery voltage and can detect when the alternator is ON. When the engine is ON the battery continuously charging and the voltage will be about 13.5V(can vary with different car models). When the engine is OFF the battery voltage drops to about 12.8V(full battery) - WiCAN can detect this drop, and if the voltage remains under the threshold for 3 min it will go to sleep and the current consumption will drop below 1mA. If the engine is turned ON it will immediately wake up and enable the WiFi/BLE. The threshold voltage is configurable and can be set in the configuration page, the default value is 13V.

2. Battery Alert:

This is an important feature for most car enthusiast who own multiple cars that are only driven few times a year. Basically if a car is not used in few month the battery will go flat and needs to be jumped. WiCAN can be configured to send an alert when the battery voltage drops under a certain level. Sleep mode has to be enabled for this feature to be useful. For now alerts can be sent on MQTT, more protocols are coming soon. If there is a specific protocol you want to be supported let me know.

Configuration:

---

1. WiFi/CAN Configuration:

1. Power up the device using the USB cable, or by plugging into the OBD-II connector.
2. The blue LED will light ON, and a WiFi device access point will start. The SSID will look like: WiCAN_xxxxxxxxxxxx
3. Connect to the SSID using the default password: @meatpi#
4. Using a web browser, go to http://192.168.80.1/
5. The status menu shows the device current configuration, if in Ap+Station mode it will show the device IP on your local network if connected successfully.
6. The WiFi menu lets you configure the WiFi parameters. It is recommended that you change the AP access point.
7. The CAN menu allows to choose the protocol set the bitrate and TCP/UPD port number.
8. When ready click submit Changes button and the device will store the configuration reboot immediately.

Note: If you intend to use the device in AP mode it is recommand that you disable the BLE function

2. BUSMaster

You need to download the right version of BUSMaster provided in this Link. Here is how to setup the hardware.

Device Configuration:

1. Go to configuration webpage.
2. Baudrate can be set in BUSMaster configuration
3. Set "Port Type" = TCP
4. Set "Protocol" = slcan
5. Click submit changes.

BUSMaster Configuration:

1. Select VSCom CAN-API by clicking on 'Driver Selection -> VSCom CAN-API"
2. Then Click on 'Channel Configuration -> Advanced'
3. Fill in the IP and port. Example: 192.168.80.1:3333
4. Check the 'Hardware Timestamps' check box.
5. Choose the Baudrate.
6. Click 'OK', then Click the Connect button on the top left corner.

3. RealDash

WiCAN can connect with RealDash using WiFi or BLE. The Protocol and CAN bitrate must be set using the configuration page. BLE is only support on Android and IOS. Windows 10 only supports WiFi connection.

WiFi Device Configuration:

1. Go to configuration webpage.
2. Select the baudrate
3. Set "Port Type" = TCP
4. Set "Protocol" = reladash 66
5. Click submit changes.

RealDash Configuration

1. Go to garage then click on the dashboard.
2. Click Add connection.
3. Select Adapter (CAN/LIN)
4. Select RealDash CAN
5. Select WIFI/LAN
6. Enter IP and Port
7. Click Done

BLE Device Configuration:

If you're using firmware verion v1.64 or below please update to the latest version before enabling BLE

1. Go to configuration webpage.
2. Select the baudrate
3. Set the "BLE Status" to enable

Note: When the BLE is connected, the device will automatically turn off the WiFi configuration access point. Once BLE is disconnected the configuration access point will turn back on.

4. SavvyCAN

1. Download SavvyCAN
2. Connect to the device AP.
3. Open SavvyCAN and Click Connection->Open Connection Window->Add New Device
4. Select "Network Connection", if you're on the same network it auto detect the IP.
5. Click Create New Connection.
6. Then select "Enable Bus" checkbox.

SocketCAN

1. WIFi:

Change to protocol in the device configuration page to "slcan", then create a virtual serial port over TCP on your Linux machine. If WiCAN is connected to your home network replace "192.168.80.1" with device IP.

sudo socat pty,link=/dev/netcan0,raw tcp:192.168.80.1:3333 &
sudo slcand -o -c -s8 /dev/netcan0 can0
sudo ifconfig can0 txqueuelen 1000
sudo ifconfig can0 up

2. USB

sudo slcand -o -s6 -t sw -S 4000000 /dev/ttyACM0 can0
sudo ifconfig can0 txqueuelen 1000
sudo ifconfig can0 up

ELM327 OBD2 Protocol

If you're using firmware verion v1.64 or below please update to the latest version before enabling BLE

1. Go to configuration webpage.
2. Select the baudrate
3. Set "Port Type" = TCP
4. Set "Protocol" = elm327
5. Enable BLE if needed. Note
6. Click submit changes.

OBD2 in RealDash

1. Go to garage then click on the dashboard.
2. Click Add connection.
3. Select Adapter OBD2
4. Select Bluetooth or WiFi
5. If WiFi fill in the IP 192.168.80.1 and port 3333.
6. Click on OBD2 PROTOCOL and select your car protocol, (11 bit ID, 500Kbit) or (11 bit ID, 250Kbit)
7. Activate Request Only First Reply
8. Click Done.

MQTT

If you're using firmware verion v1.64 or below please update to the latest version before enabling MQTT

Currently only non-secure MQTT is supported, it's highly recommended that you only use it with local MQTT broker and not use public brokers otherwise your CAN bus might be publicly exposed.

To use MQTT client simply Enable in the configuration page and fill in the broker details. You also need to note the device ID, which will be used to communicate with the device. The device ID "xxxxxxxxxxxx" is part of the AP ssid mentioned in WiFi/CAN Configuration WiCAN_xxxxxxxxxxxx. This will alow you to communicate with multiple WiCAN device if needed.

Example: If the AP ssid is "WiCAN_112233445566", the device ID is 112233445566.

1. Status:

When the device connects to the MQTT broker it will publish a status message to the status topic.

- Status Topic: wican/xxxxxxxxxxxx/status

- Status Message JSON:

{"status": "offline"} or {"status": "online"}

2. Receive Frames:

To receive CAN frames simply subscribe to the receive topic. Each MQTT message might contain more than 1 frame.

- Receive Topic: wican/xxxxxxxxxxxx/can/rx

- Received Message JSON:

{"bus":0,"type":"rx","ts":34610,"frame":[{"id":123,"dlc":8,"rtr":false,"extd":false,"data":[1,2,3,4,5,6,7,8]},{"id":124,"dlc":8,"rtr":false,"extd":true,"data":[1,2,3,4,5,6,7,8]}]}

- Received Message JSON Schema:

3. Transmit Frames:

- Transmit Topic: wican/xxxxxxxxxxxx/can/tx

- Transmit Message JSON:

{"bus":0,"type":"tx","frame":[{"id":123,"dlc":8,"rtr":false,"extd":true,"data":[1,2,3,4,5,6,7,8]},{"id":124,"dlc":8,"rtr":false,"extd":true,"data":[1,2,3,4,5,6,7,8]}]}

- Transmit Message JSON Schema:

Home Assistant

WiCAN is able to send CAN bus messages to Home Assistant using MQTT protocol. I found that using Node-RED is the simplest way to create automation based on the CAN messages received. This short video highlights some of the steps https://youtu.be/oR5HQIUPR9I

1. Install Home Assistant Mosquitto broker add-on
2. Create Home Assistant new user account for WiCAN. These user credentials will be used to set up the MQTT setting for WiCAN.
3. Connect to WiCAN access point WiCAN_xxxxxxxxxxxx then, using a web browser, go to http://192.168.80.1/
4. Set the "Mode" to Ap+Station
5. Fill in your Home WiFi network SSID and Password.
6. Enable MQTT and fill in the Home Assistant credentials created in step 2
7. Install Home Assistant Node-RED Add-on
8. Download wican_example_flow.json and replace device_id with your WiCAN ID.
9. Open Node-RED Add-on and import the edited "wican_example_flow.json"
10. Double click on the subsction Node and edit the server fill in MQTT broker IP address and credentials created in step 2
11. Click deploy.
12. To create a new MQTT sensor, you’ll need to edit the configuration.yaml file by adding the following lines:

mqtt:
  sensor:
    - name: "Amb Temp"
      state_topic: "CAR1/Amb_Temp"
      unit_of_measurement: "C"
      value_template: "{{ value_json.amb_temp }}"
    - name: "Fuel Level"
      state_topic: "CAR1/Fuel_Level"
      unit_of_measurement: "%"
      value_template: "{{ value_json.fuel_level }}"

11. Restart Home assistant
12. After restart go to dashboard and Add new Card entity.

Workflow summery

In this example we've got one Node subscribed to topic wican/device_id/status, when WiCAN connects to the local network it will publish {"status": "online"} . Once the Node function Send Get Amb Temp req receives online status it will send a OBD2 request to get the ambient temperature. The OBD2 request message looks like this:

{ "bus": "0", "type": "tx", "frame": [{ "id": 2015, "dlc": 8, "rtr": false, "extd": false, "data": [2, 1, 70, 170, 170, 170, 170, 170] }] }

Frame ID : 2015 or 0x7DF PID: 70 or 0x46

Here is a good reference on how to construct a PID request. Note select DEC from drop down list.

We have another Node subscribed to topic wican/device_id/can/rx, once the car ECU responds to the request the function Parse Amb Temp RSP will parse the message and publish a message to topic CAR1/Amb_Temp. Notice that when you edited configuration.yaml file create an MQTT Entity that subscribes to CAR1/Amb_Temp and expects a message { value_json.amb_temp } with unit_of_measurement C.

Firmware Update

1. OTA:

1. Download the latest release version, or compile your own.
2. Go the device configuration page.
3. Click on the "About" tab.
4. Click on "Choose File".
5. Select the binary file. Eample: wican-fw_v130.bin
6. Click update, update should take about 30sec.

NOTE: After flashing, the device configuration might be erased.

Note: for firmware version v1.00 use USB cable to flash the unit.

2. USB Flash:

Use the ESP flash tool to update the firmware, just follow the same setting in the picture below. Make sure to select ESP32-C3 and USB mode. esptool.py also can also be used to flash a new firmware.

1. Download ESP flash tool
2. Download the latest firmware zip file from the releases page.
3. Select ESP32C3, develop and USB then click ok

4. Set the configuration as the picture below, select and fill in the address for each binary.

5. Short the pins as shown, then plug in the USB cable.

6. After you plug in the USB cable the Orange LED will light up. Now click START button on the flash tool.

NOTE: After flashing, the device configuration might be erased.

---

© 2022 meatPi Electronics | www.meatpi.com | PO Box 5005 Clayton, VIC 3168, Australia