Skip to content

Commit

Permalink
improvements suggested by reviewer
Browse files Browse the repository at this point in the history
  • Loading branch information
camueller committed Oct 20, 2024
1 parent 9d1fa9e commit 11a9ebf
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions docs/content/0.Config/5.Automate/1.Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,21 @@ title: Usage

# Automate

The "Automate" feature can be used to **periodically request one or more PID**s and post the results to an **MQTT server**. Therefore, this feature requires [MQTT configured in WiCAN](../MQTT.md).
The "Automate" feature can be used to **periodically request one or more PID**s.

First of all **the `Protocol` in the `CAN` section on the "Settings" tab has to be set to `AutoPID`**

Configuration of "Automate" itself is done on the "Automate" tab.
Configuration of "Automate" itself is done on the "Automate" tab.

Responses can be monitored:
- by monitoring the MQTT subject configured if [MQTT is enabled](../MQTT.md)
![image](/config/automate/monitor_mqtt.png)

- pointing the Web browser to `http://<WiCAN IP adress>/autopid_data` if [MQTT is NOT enabled](../MQTT.md)
![image](/config/automate/monitor_http.png)

## Vehicle Profiles
The "Automate" feature automatically downloads **vehicle profiles** from GitHub containing some popular PIDs (e.g. SoC, SoH). These vehicle profiles are car vendor and/or model specific. There is a growing [list of supported vehicles](2.Supported_Vehicles.md).
Initially the download of **vehicle profiles** has to be triggered by pressing the sync button next to the `Vehicle Model` dropdown box. These vehicle profiles are car vendor and/or model specific and contain some popular PIDs (e.g. SoC, SoH). There is a growing [list of supported vehicles](2.Supported_Vehicles.md).

If WiCAN cannot download vehicles profiles for any reason you man also [download in manually](https://github.com/meatpiHQ/wican-fw/blob/main/vehicle_profiles.json) and press the `Choose File` button to select the file downloaded.

Expand All @@ -21,14 +28,14 @@ If vehicles profiles are available to WiCAN the appropriate `Vehicle Model` shou

In `Cycle Time(ms)` the interval is configured after which the PIDs, contained in the vehicle profile, are requested.

The results are posted to the MQTT topic specified in `Destination Topic`.
The results are posted to the MQTT topic specified in `Destination Topic` if [MQTT is enabled](../MQTT.md).

![image](/config/automate/automate.png)


## Custom PIDs

If there is no vehicle profile for your car, or it does not contain the PIDs you would like to use, the "Custom PIDs" feature should be used. Basically you can enter the same parameters contained in the vehicle profiles:
If there is no vehicle profile for your car, or it does not contain the PIDs you would like to use, the "Custom PIDs" feature should be used. Basically the same parameters as contained in the vehicle profiles can be entered:

- **Custom Initialisation**: will be sent by WiCAN prior requesting particular PIDs
- **Name**: the attribute name containing the result of the PID request
Expand All @@ -43,4 +50,6 @@ The `Delete` button deletes the configuration of the corresponding PID

In order to use Custom PIDs `Vehicle Specific` has to be set to `Disable`.

**At the moment Custom PIDs are only supported over MQTT**. Therefore [MQTT has to be enabled](../MQTT.md).

![image](/config/automate/custom_pids.png)
Binary file added docs/public/config/automate/monitor_http.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/config/automate/monitor_mqtt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 11a9ebf

Please sign in to comment.