Add get_version (#258)

emfcamp · Aug 4, 2024 · eec81ad · eec81ad
1 parent 6a34ff7
commit eec81ad
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/tildagon-apps/reference/badge-hardware.md b/docs/tildagon-apps/reference/badge-hardware.md
@@ -743,3 +743,23 @@ i2c.writeto_mem(42, 2, b'\x10')
 ```
 
 For more information, see [MicroPython I2C docs](https://docs.micropython.org/en/latest/library/machine.I2C.html).
+
+## Version
+
+You can use the `ota` package to obtain the insntalled TildagonOS version:
+
+### Usage
+
+To use the buttons:
+
+1. Import the `ota` package:
+
+   ```python
+   import ota
+   ```
+
+2. Use the `get_version()` method:
+
+   ```python
+   ota.get_version()
+   ```
diff --git a/docs/tildagon-apps/reference/reference.md b/docs/tildagon-apps/reference/reference.md
@@ -33,6 +33,7 @@ You can use the following hardware with the inbuilt interfaces:
 - [Pins](./badge-hardware.md#pins)
 - [IMU](./badge-hardware.md#imu)
 - [Power](./badge-hardware.md#power)
+- [Version](./badge-hardware.md#over-the-air-ota)
 
 ## Using APIs