Skip to content

Commit

Permalink
Merge pull request #58 from tesla-local-control/Remove_BLE_MAC_LIST_d…
Browse files Browse the repository at this point in the history
…oc_refs

Remove ble mac list doc refs
  • Loading branch information
iainbullock authored Sep 15, 2024
2 parents b9d991d + 1ec7610 commit 02c5edd
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 10 deletions.
1 change: 1 addition & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ vii. Check the logs `docker logs -f tesla_ble_mqtt`. Typical logs after start up
MQTT_USERNAME=XXXXXX
PRESENCE_DETECTION_LOOP_DELAY=120
PRESENCE_DETECTION_TTL=240
TEMPERATURE_UNIT_FAHRENHEIT=false
VIN_LIST=LRWXXXXXXXXXXX403
ENABLE_HA_FEATURES=true
Setting up MQTT clients with authentication
Expand Down
6 changes: 2 additions & 4 deletions INSTALLwDockerfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ iv. Download docker-compose.yml and stack.env from the github repository:
```
v. You will need to edit docker-compose.yml. Change the line `image: "iainbullock/tesla_ble_mqtt:latest"` to `image: "tesla_ble_mqtt:latest"`
<br /><br />
vi. Update the environment variables in stack.env according to your needs. As a minimum enter the VIN of your car, and the connection details for your MQTT server. If you want BLE detection enter the BLE MAC address of the car (see below for instructions on how to find this TODO):
vi. Update the environment variables in stack.env according to your needs. As a minimum enter the VIN of your car, and the connection details for your MQTT server:
```shell
# Mandatory; if multiple VINs separate with , or white space
#
Expand All @@ -87,9 +87,6 @@ MQTT_USERNAME=
MQTT_PASSWORD=
# Optional for car presence detection; If multiple cars, separate with , or white space
#
BLE_MAC_LIST=
# Default 5 (seconds)
#
BLE_CMD_RETRY_DELAY=
# Default 120 (seconds)
#
Expand Down Expand Up @@ -130,6 +127,7 @@ Configuration Options are:
MQTT_USERNAME=XXXXXX
PRESENCE_DETECTION_LOOP_DELAY=120
PRESENCE_DETECTION_TTL=240
TEMPERATURE_UNIT_FAHRENHEIT=false
VIN_LIST=LRWXXXXXXXXXXX403
ENABLE_HA_FEATURES=true
Setting up MQTT clients with authentication
Expand Down
9 changes: 6 additions & 3 deletions INSTALLwPortDFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,21 @@ vi. Scroll further down the Create stack page. In the Environment variables sect
<br /><br />
vii. A box to enter environment variables will open up. Copy and Paste the contents of [stack.env](https://raw.githubusercontent.com/tesla-local-control/tesla_ble_mqtt_docker/main/stack.env) into the box, and press the blue 'Deploy the stack' button:
<br /><br />
<img width="714" alt="image" src="https://github.com/user-attachments/assets/cb09e093-3791-4fb4-bfea-07b0f7b2f821">
<img width="714" alt="image" src="https://github.com/user-attachments/assets/6468115c-de60-41e3-8217-f7f470ed5721">
<img width="714" alt="image" src="https://github.com/user-attachments/assets/92a676c7-4822-4305-bf04-1445de4819af">
<br /><br />
viii. After some time, if all is well, the message 'Success. Stack successfully deployed' will briefly pop-up, and you will be returned to the 'Stacks list' page. Click the newly created tesla_ble_mqtt stack to enter the 'Stack details' page for the new stack. Click the red 'Stop this stack' button, then click the 'Editor' tab:
<br /><br />
![image](https://github.com/user-attachments/assets/92351402-e404-4926-b69e-c1420ed500a9)
<br /><br />
ix. Scroll down to the 'Environment variables' section. Enter the values required for your setup in the respective fields and when completed press the 'Update the stack' button. Use [stack.env](https://github.com/tesla-local-control/tesla_ble_mqtt_docker/blob/main/stack.env) as a reference
<br /><br />
![image](https://github.com/user-attachments/assets/a0a0f149-92ba-49e0-a8fa-b149983f9172)
<img alt="image" src="https://github.com/user-attachments/assets/00560fee-63e7-4618-84bf-6c3e5876aa17">
<br /><br />
x. If all is well, the message 'Success. Stack successfully deployed' will briefly pop-up, and you will be returned to the 'Stacks list' page. Click the tesla_ble_mqtt stack to enter the 'Stack details' page for the new stack. In the Containers section click the tesla_ble_mqtt container to enter the 'Container details' page. From here you can view the logs by pressing the Logs link in the 'Container status' section. Succesful logs look something like this at startup:
<br /><br />
![Screenshot 2024-07-15 180414](https://github.com/user-attachments/assets/29a47eeb-e509-4541-a130-37e20629b3d4)
<img alt="image" src="https://github.com/user-attachments/assets/b6951b9e-e5c7-439e-8ceb-88528cbf87eb">




8 changes: 5 additions & 3 deletions INSTALLwPortainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,21 @@ iv. Scroll further down the Create stack page. In the Environment variables sect
<br /><br />
v. A box to enter environment variables will open up. Copy and Paste the contents of [stack.env](https://raw.githubusercontent.com/tesla-local-control/tesla_ble_mqtt_docker/main/stack.env) into the box, and press the blue 'Deploy the stack' button:
<br /><br />
<img width="714" alt="image" src="https://github.com/user-attachments/assets/cb09e093-3791-4fb4-bfea-07b0f7b2f821">
<img width="714" alt="image" src="https://github.com/user-attachments/assets/6468115c-de60-41e3-8217-f7f470ed5721">
<img width="714" alt="image" src="https://github.com/user-attachments/assets/92a676c7-4822-4305-bf04-1445de4819af">
<br /><br />
vi. After some time, if all is well, the message 'Success. Stack successfully deployed' will briefly pop-up, and you will be returned to the 'Stacks list' page. Click the newly created tesla_ble_mqtt stack to enter the 'Stack details' page for the new stack. Click the red 'Stop this stack' button, then click the 'Editor' tab:
<br /><br />
![image](https://github.com/user-attachments/assets/92351402-e404-4926-b69e-c1420ed500a9)
<br /><br />
vii. Scroll down to the 'Environment variables' section. Enter the values required for your setup in the respective fields and when completed press the 'Update the stack' button. Use [stack.env](https://github.com/tesla-local-control/tesla_ble_mqtt_docker/blob/main/stack.env) as a reference
<br /><br />
![image](https://github.com/user-attachments/assets/a0a0f149-92ba-49e0-a8fa-b149983f9172)
<img alt="image" src="https://github.com/user-attachments/assets/00560fee-63e7-4618-84bf-6c3e5876aa17">
<br /><br />
vii. If all is well, the message 'Success. Stack successfully deployed' will briefly pop-up, and you will be returned to the 'Stacks list' page. Click the tesla_ble_mqtt stack to enter the 'Stack details' page for the new stack. In the Containers section click the tesla_ble_mqtt container to enter the 'Container details' page. From here you can view the logs by pressing the Logs link in the 'Container status' section. Succesful logs look something like this at startup:
<br /><br />
![Screenshot 2024-07-15 180414](https://github.com/user-attachments/assets/065ece8f-2d91-4679-81be-12195fe89a81)
<img alt="image" src="https://github.com/user-attachments/assets/b6951b9e-e5c7-439e-8ceb-88528cbf87eb">




0 comments on commit 02c5edd

Please sign in to comment.