Skip to content

Commit

Permalink
better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
robotastic committed May 12, 2024
1 parent 3c5b629 commit 3b1eb17
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,18 +103,12 @@ Running this repo requires that you have

## Usage

Spinning up this system requires an MQTT server and this container to
be included in your `docker-compose.yml`. You can find an example of
this workflow in this repository's `docker-compose.yml`. Additionally,
some editing of relevant environment variables will be required based
upon your system's configuration of topics to subscribe to and MQTT
configuration. Examples of these environment variables can be found in
this repository's `template.axis-ptz-controller.env` file.

Copying the project `docker-compose` statements into a master
`docker-compose.yml` and `.env` files with your entire system of
containers is the preferred workflow. Find an application architecture
diagram example of how the usage of this module was envisioned below.
This module is designed to be used in concert with other modules to
build a complete tracking system. [SkyScan]() is an example of that.
Checkout the `docker-compose.yml` in that repo to see how these modules
can be connected together. The configuration for the system is stored in environment files that are loaded
in when it is started up. Examples of the different environment files
are included in the SkyScan repo, configure them to match your setup.

```mermaid
Expand All @@ -135,6 +129,8 @@ style capturedata fill:#80c342,color:#ffffff
```



## Roadmap

- TBA
Expand Down
1 change: 1 addition & 0 deletions axis-ptz-controller/axis_ptz_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,7 @@ def _log_config(self) -> None:
"image_filename_topic": self.image_filename_topic,
"image_capture_topic": self.image_capture_topic,
"logger_topic": self.logger_topic,
"manual_control_topic": self.manual_control_topic,
"tripod_longitude": self.camera.tripod_longitude,
"tripod_latitude": self.camera.tripod_latitude,
"tripod_altitude": self.camera.tripod_altitude,
Expand Down

0 comments on commit 3b1eb17

Please sign in to comment.