Skip to content

Commit

Permalink
update docs for arc, bump version & update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
time4tea committed Jan 2, 2024
1 parent 93a26d5 commit 1d42b58
Show file tree
Hide file tree
Showing 20 changed files with 38 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.122.0
current_version = 0.123.0

[bumpversion:file:setup.py]

Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,9 @@ https://github.com/JuanIrache/gopro-telemetry
## Latest Changes

If you find any issues with new releases, please discuss in [GitHub Discussions](https://github.com/time4tea/gopro-dashboard-overlay/discussions)
- 0.123.0 [Enhancement] Use better (but every so slightly slower, shouldn't make a huge difference) rotation method for maps - will give much better quality.
- Add new gauge - `cairo-gauge-donut` see [docs/xml](docs/xml/examples/06-cairo-gauge-donut)
- It looks like this: ![](docs/xml/examples/06-cairo-gauge-donut/06-cairo-gauge-donut-6.png)
- 0.122.0 [Breaking] Previous change announced in v0.100.0 wasn't actually taking effect. Use --gpx-merge OVERWRITE to prefer values in gpx to gopro.
- 0.121.0 [Enhancement] Build in some simple ffmpeg profiles - `nvgpu`, `nnvgpu`, `mov`, `vp8`, and `vp9` - see [docs/bin#ffmpeg-profiles](docs/bin#ffmpeg-profiles)
- 0.120.0 [Fix] Resolve some Python3.10 compatibility issues. Thanks, [@KyleGW](https://github.com/KyleGW)
Expand Down
8 changes: 7 additions & 1 deletion build-scripts/examples/06-cairo-gauge-donut.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,17 @@ There are 5 sectors by default. This can be changed with `sectors`
{{ <component type="cairo-gauge-donut" metric="speed" units="mph" length="90" sectors="20" /> }}
{{ <component type="cairo-gauge-donut" metric="speed" units="mph" length="180" sectors="6" /> }}

# Range Markers

You can set range markers, like the`cairo-gauge-arc-annotated` widget.

{{ <component type="cairo-gauge-donut" metric="speed" units="mph" length="180" sectors="6" max="60" arc-value-upper="60" arc-value-lower="50" arc-inner-rgb="255,0,255,50" arc-outer-rgb="255,0,0,250" /> }}

# Colours

Various colours can be set, either as RGB, or RGBA values.

The following are available to change: `background-inner-rgb`, `background-outer-rgb`, `major-ann-rgb`, `minor-ann-rgb`, `needle-rgb`, `major-tick-rgb`, `minor-tick-rgb`
The following are available to change: `background-inner-rgb`, `background-outer-rgb`, `major-ann-rgb`, `minor-ann-rgb`, `needle-rgb`, `major-tick-rgb`, `minor-tick-rgb`, `arc-inner-rgb`, `arc-outer-rgb`

{{ <component type="cairo-gauge-donut" metric="speed" units="mph" background-inner-rgb="255,0,0"/> }}
{{ <component type="cairo-gauge-donut" metric="speed" units="mph" background-outer-rgb="0,255,0"/> }}
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/xml/examples/06-cairo-gauge-donut/06-cairo-gauge-donut-11.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 modified docs/xml/examples/06-cairo-gauge-donut/06-cairo-gauge-donut-12.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 modified docs/xml/examples/06-cairo-gauge-donut/06-cairo-gauge-donut-13.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 modified docs/xml/examples/06-cairo-gauge-donut/06-cairo-gauge-donut-14.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 modified docs/xml/examples/06-cairo-gauge-donut/06-cairo-gauge-donut-15.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 modified docs/xml/examples/06-cairo-gauge-donut/06-cairo-gauge-donut-16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/xml/examples/06-cairo-gauge-donut/06-cairo-gauge-donut-18.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 modified docs/xml/examples/06-cairo-gauge-donut/06-cairo-gauge-donut-19.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/xml/examples/06-cairo-gauge-donut/06-cairo-gauge-donut-21.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 25 additions & 14 deletions docs/xml/examples/06-cairo-gauge-donut/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,53 +93,64 @@ There are 5 sectors by default. This can be changed with `sectors`
<kbd>![06-cairo-gauge-donut-8.png](06-cairo-gauge-donut-8.png)</kbd>


# Range Markers

You can set range markers, like the`cairo-gauge-arc-annotated` widget.


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" length="180" sectors="6" max="60" arc-value-upper="60" arc-value-lower="50" arc-inner-rgb="255,0,255,50" arc-outer-rgb="255,0,0,250" />
```
<kbd>![06-cairo-gauge-donut-9.png](06-cairo-gauge-donut-9.png)</kbd>


# Colours

Various colours can be set, either as RGB, or RGBA values.

The following are available to change: `background-inner-rgb`, `background-outer-rgb`, `major-ann-rgb`, `minor-ann-rgb`, `needle-rgb`, `major-tick-rgb`, `minor-tick-rgb`
The following are available to change: `background-inner-rgb`, `background-outer-rgb`, `major-ann-rgb`, `minor-ann-rgb`, `needle-rgb`, `major-tick-rgb`, `minor-tick-rgb`, `arc-inner-rgb`, `arc-outer-rgb`


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" background-inner-rgb="255,0,0"/>
```
<kbd>![06-cairo-gauge-donut-9.png](06-cairo-gauge-donut-9.png)</kbd>
<kbd>![06-cairo-gauge-donut-10.png](06-cairo-gauge-donut-10.png)</kbd>


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" background-outer-rgb="0,255,0"/>
```
<kbd>![06-cairo-gauge-donut-10.png](06-cairo-gauge-donut-10.png)</kbd>
<kbd>![06-cairo-gauge-donut-11.png](06-cairo-gauge-donut-11.png)</kbd>


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" major-ann-rgb="255,0,0"/>
```
<kbd>![06-cairo-gauge-donut-11.png](06-cairo-gauge-donut-11.png)</kbd>
<kbd>![06-cairo-gauge-donut-12.png](06-cairo-gauge-donut-12.png)</kbd>


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" minor-ann-rgb="255,0,0"/>
```
<kbd>![06-cairo-gauge-donut-12.png](06-cairo-gauge-donut-12.png)</kbd>
<kbd>![06-cairo-gauge-donut-13.png](06-cairo-gauge-donut-13.png)</kbd>


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" major-tick-rgb="255,0,0"/>
```
<kbd>![06-cairo-gauge-donut-13.png](06-cairo-gauge-donut-13.png)</kbd>
<kbd>![06-cairo-gauge-donut-14.png](06-cairo-gauge-donut-14.png)</kbd>


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" minor-tick-rgb="255,0,0"/>
```
<kbd>![06-cairo-gauge-donut-14.png](06-cairo-gauge-donut-14.png)</kbd>
<kbd>![06-cairo-gauge-donut-15.png](06-cairo-gauge-donut-15.png)</kbd>


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" needle-rgb="255,0,255"/>
```
<kbd>![06-cairo-gauge-donut-15.png](06-cairo-gauge-donut-15.png)</kbd>
<kbd>![06-cairo-gauge-donut-16.png](06-cairo-gauge-donut-16.png)</kbd>


# Transparency
Expand All @@ -150,36 +161,36 @@ Any colour that is completely transparent will disappear... this can be used to
```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" background-inner-rgb="255,0,0,0"/>
```
<kbd>![06-cairo-gauge-donut-16.png](06-cairo-gauge-donut-16.png)</kbd>
<kbd>![06-cairo-gauge-donut-17.png](06-cairo-gauge-donut-17.png)</kbd>


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" major-ann-rgb="255,0,0,0"/>
```
<kbd>![06-cairo-gauge-donut-17.png](06-cairo-gauge-donut-17.png)</kbd>
<kbd>![06-cairo-gauge-donut-18.png](06-cairo-gauge-donut-18.png)</kbd>


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" minor-ann-rgb="255,0,0,0"/>
```
<kbd>![06-cairo-gauge-donut-18.png](06-cairo-gauge-donut-18.png)</kbd>
<kbd>![06-cairo-gauge-donut-19.png](06-cairo-gauge-donut-19.png)</kbd>


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" major-tick-rgb="255,0,0,0"/>
```
<kbd>![06-cairo-gauge-donut-19.png](06-cairo-gauge-donut-19.png)</kbd>
<kbd>![06-cairo-gauge-donut-20.png](06-cairo-gauge-donut-20.png)</kbd>


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" minor-tick-rgb="255,0,0,0"/>
```
<kbd>![06-cairo-gauge-donut-20.png](06-cairo-gauge-donut-20.png)</kbd>
<kbd>![06-cairo-gauge-donut-21.png](06-cairo-gauge-donut-21.png)</kbd>


```xml
<component type="cairo-gauge-donut" metric="speed" units="mph" needle-rgb="255,0,255,40"/>
```
<kbd>![06-cairo-gauge-donut-21.png](06-cairo-gauge-donut-21.png)</kbd>
<kbd>![06-cairo-gauge-donut-22.png](06-cairo-gauge-donut-22.png)</kbd>


2 changes: 1 addition & 1 deletion gopro_overlay/__version__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
__title__ = 'gopro_overlay'
__description__ = 'Dashboards for GoPro'
__url__ = 'https://github.com/time4tea/gopro-dashboard-overlay'
__version__ = '0.122.0'
__version__ = '0.123.0'
__author__ = 'James Richardson'
__author_email__ = '[email protected]'
__license__ = 'GPLv3'
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

setup(
name="gopro-overlay",
version="0.122.0",
version="0.123.0",
description="Overlay graphics dashboards onto GoPro footage, or create videos from GPX or FIT files",
long_description=README,
long_description_content_type="text/markdown",
Expand Down

0 comments on commit 1d42b58

Please sign in to comment.