docs / examples

also added some types

build-scripts/examples/05-moving-map.md

@@ -1,3 +1,4 @@
+<!-- Dimension(256,256) -->
 
 # Moving Map
 

build-scripts/examples/06-cairo-gauge-arc-annotated.md

@@ -1,3 +1,4 @@
+<!-- Dimension(256,256) -->
 
 # Cairo Gauge Arc Annotated
 

build-scripts/examples/06-cairo-gauge-donut.md

@@ -1,3 +1,4 @@
+<!-- Dimension(256,256) -->
 
 # Cairo Gauge Donut
 

build-scripts/examples/06-cairo-gauge-marker.md

@@ -1,3 +1,4 @@
+<!-- Dimension(256,256) -->
 
 # Cairo Gauge Marker
 

build-scripts/examples/06-cairo-gauge-round-annotated.md

@@ -1,3 +1,4 @@
+<!-- Dimension(256,256) -->
 
 # Cairo Gauge Round Annotated
 

build-scripts/examples/06-journey-map.md

@@ -1,3 +1,4 @@
+<!-- Dimension(256,256) -->
 
 # Journey Map
 

build-scripts/examples/06-moving-journey-map.md

@@ -1,3 +1,4 @@
+<!-- Dimension(384,384) -->
 
 # Moving Journey Map
 

build-scripts/examples/07-air-speed-indicator.md

@@ -1,12 +1,11 @@
+<!-- Dimension(256,256) -->
 
 # Air Speed Indicator
 
-** Experimental **
-
 The Air Speed Indicator component draws an air speed indicator.
 
 The best speed indicator that exists at the moment is `speed`, but this does represent
-the SOG or Groundspeed, not airspeed, but it might be OK for a video overlay.
+the SOG or Ground speed, not airspeed, but it might be OK for a video overlay.
 
 {{  <component type="asi" vs0="10" /> }}
 

build-scripts/examples/07-bar.md

@@ -1,4 +1,4 @@
-
+<!-- Dimension(500,150) -->
 # Bar
 
 Draws a very simple horizontal bar with current metric value

build-scripts/examples/07-chart.md

@@ -1,3 +1,4 @@
+<!-- Dimension(256,128) -->
 
 # Chart
 

build-scripts/examples/07-motor-speed-indicator.md

@@ -0,0 +1,69 @@
+
+# Motor Speed Indicator
+
+The Motor Speed Indicator component draws a circular speed indicator
+
+
+{{  <component type="msi" end="100" /> }}
+
+
+
+# Sections
+
+The following sections can be set 
+
+| Attribute | Description        | 
+|-----------|--------------------|
+| green     | Green Section Max  |
+| yellow    | Yellow Section Max |
+| end       | End of Dial        |
+
+
+{{ <component type="msi" green="30" yellow="60" end="100" /> }}
+
+
+# Metrics & Conversions
+
+The MSI defaults to speed in knots, but like a text metric, can access any available information, and convert it to
+other units
+
+{{  <component type="msi" units="mph" end="100" /> }}
+
+{{  <component type="msi" metric="alt" units="feet" /> }}
+
+# Size
+
+The component can be sized - sizes that are too small or big might not render quite right
+
+{{ <component type="msi" size="128" /> }}
+
+# Rotation
+
+Can rotate the entire gauge clockwise using `rotate`
+
+{{ <component type="msi" rotate="45" /> }}
+{{ <component type="msi" rotate="90" /> }}
+{{ <component type="msi" rotate="180" /> }}
+
+
+# Needle or no needle
+
+The MSI component has a needle-less form which has a different style
+
+{{ <component type="msi" needle="no" rotate="45" /> }}
+
+# Variant
+
+The MSI component has a variant "msi2", which doesn't have a needle, it has the same other attributes 
+`green`, `yellow`, `end`
+
+{{ <component type="msi2" /> }}
+
+
+
+# Font
+
+The text font can be changed in size
+
+{{ <component type="msi" textsize="24" /> }}
+

build-scripts/examples/07-zone-bar.md

@@ -1,3 +1,5 @@
+<!-- Dimension(500,100) -->
+
 # Zone Bar
 
 Draws a simple horizontal bar with current metric value, with 4 zones - so suitable for

build-scripts/examples/08-translate.md

@@ -1,3 +1,4 @@
+<!-- Dimension(256,256) -->
 
 # Translate
 

build-scripts/examples/09-frame.md

@@ -1,3 +1,4 @@
+<!-- Dimension(256,256) -->
 
 # Frame
 

build-scripts/generate-examples.py

@@ -28,27 +28,6 @@ def alphanum_key(s):
     return [tryint(c) for c in re.split(r'([0-9]+)', s)]
 
 
-dimensions_by_file = {
-    "07-bar.md": Dimension(500, 150),
-    "07-zone-bar.md": Dimension(500, 100),
-    "05-moving-map.md": Dimension(256, 256),
-    "06-journey-map.md": Dimension(256, 256),
-    "06-cairo-gauge-marker.md": Dimension(256, 256),
-    "06-cairo-gauge-round-annotated.md": Dimension(256, 256),
-    "06-cairo-gauge-arc-annotated.md": Dimension(256, 256),
-    "06-cairo-gauge-donut.md": Dimension(256, 256),
-    "06-moving-journey-map.md": Dimension(384, 384),
-    "07-air-speed-indicator.md": Dimension(256, 256),
-    "07-chart.md": Dimension(256, 128),
-    "08-translate.md": Dimension(256, 256),
-    "09-frame.md": Dimension(256, 256),
-}
-
-
-def dimensions_for(filepath: str) -> Dimension:
-    return dimensions_by_file.get(os.path.basename(filepath), Dimension(200, 100))
-
-
 AUTO_HEADER = "<!-- \n\nAuto Generated File DO NOT EDIT \n\n-->\n"
 
 if __name__ == "__main__":
@@ -88,6 +67,12 @@ def dimensions_for(filepath: str) -> Dimension:
 
             example_dest = os.path.join(dest, basename.stem)
 
+            dimensions_match = re.search(r"Dimension\((\d+),(\d+)\)", example_markdown)
+            if dimensions_match is None:
+                dimensions = Dimension(200, 100)
+            else:
+                dimensions = Dimension(int(dimensions_match.group(1)), int(dimensions_match.group(2)))
+
             while True:
                 match = re.search(r"{{(.+?)}}", example_markdown, re.MULTILINE | re.DOTALL)
                 if match is None:
@@ -116,7 +101,7 @@ def dimensions_for(filepath: str) -> Dimension:
                 )
 
                 overlay = Overlay(framemeta=timeseries, create_widgets=layout)
-                supplier = SimpleFrameSupplier(dimensions_for(filepath), background=(0,0,0,255))
+                supplier = SimpleFrameSupplier(dimensions, background=(0,0,0,255))
                 image = overlay.draw(timeseries.mid, supplier.drawing_frame())
 
                 os.makedirs(example_dest, exist_ok=True)

docs/xml/examples/05-moving-map/README.md

@@ -3,6 +3,7 @@
 Auto Generated File DO NOT EDIT 
 
 -->
+<!-- Dimension(256,256) -->
 
 # Moving Map
 

docs/xml/examples/06-cairo-gauge-arc-annotated/README.md

@@ -3,6 +3,7 @@
 Auto Generated File DO NOT EDIT 
 
 -->
+<!-- Dimension(256,256) -->
 
 # Cairo Gauge Arc Annotated
 

docs/xml/examples/06-cairo-gauge-donut/README.md

@@ -3,6 +3,7 @@
 Auto Generated File DO NOT EDIT 
 
 -->
+<!-- Dimension(256,256) -->
 
 # Cairo Gauge Donut
 

docs/xml/examples/06-cairo-gauge-marker/README.md

@@ -3,6 +3,7 @@
 Auto Generated File DO NOT EDIT 
 
 -->
+<!-- Dimension(256,256) -->
 
 # Cairo Gauge Marker
 

docs/xml/examples/06-cairo-gauge-round-annotated/README.md

@@ -3,6 +3,7 @@
 Auto Generated File DO NOT EDIT 
 
 -->
+<!-- Dimension(256,256) -->
 
 # Cairo Gauge Round Annotated
 

docs/xml/examples/06-journey-map/README.md

@@ -3,6 +3,7 @@
 Auto Generated File DO NOT EDIT 
 
 -->
+<!-- Dimension(256,256) -->
 
 # Journey Map
 

docs/xml/examples/06-moving-journey-map/README.md

@@ -3,6 +3,7 @@
 Auto Generated File DO NOT EDIT 
 
 -->
+<!-- Dimension(384,384) -->
 
 # Moving Journey Map
 

docs/xml/examples/07-air-speed-indicator/README.md

@@ -3,15 +3,14 @@
 Auto Generated File DO NOT EDIT 
 
 -->
+<!-- Dimension(256,256) -->
 
 # Air Speed Indicator
 
-** Experimental **
-
 The Air Speed Indicator component draws an air speed indicator.
 
 The best speed indicator that exists at the moment is `speed`, but this does represent
-the SOG or Groundspeed, not airspeed, but it might be OK for a video overlay.
+the SOG or Ground speed, not airspeed, but it might be OK for a video overlay.
 
 
 ```xml

docs/xml/examples/07-bar/README.md

@@ -3,7 +3,7 @@
 Auto Generated File DO NOT EDIT 
 
 -->
-
+<!-- Dimension(500,150) -->
 # Bar
 
 Draws a very simple horizontal bar with current metric value

docs/xml/examples/07-chart/README.md

@@ -3,6 +3,7 @@
 Auto Generated File DO NOT EDIT 
 
 -->
+<!-- Dimension(256,128) -->
 
 # Chart