More payload options available

Author: kingature

README.md

@@ -1,68 +1,57 @@
 
 # OpenTouch Interface
 
-The OpenTouch Interface is a Python package designed to provide a unified interface for various touch sensors. It simplifies the process of interacting with touch sensors by providing a consistent API regardless of the specific sensor being used.
+A Python package designed to provide a unified interface for various touch sensors. It simplifies the process of interacting with touch sensors by providing a consistent API regardless of the specific sensor being used.
 
 We also provide an easy-to-use web interface that lets you connect to the sensors and show their data stream without the need to code.
 
 ---
 
-## Features
+## Overview
+- **Unified API**: Interact with multiple types of touch sensors using a single, consistent API.
+- **Web Dashboard**: Manage sensors, record/replay data, and annotate data directly through a web interface.
+- **Easy Configuration**: Use YAML config files to quickly set up and manage sensors.
 
-We currently offer a unified API along with a simple web interface for the following touch sensors:
+**Supported sensors**:
 - [Digit](https://digit.ml/)
 - [Digit360](https://digit.ml/digit360.html)
 - [GelSight Mini](https://www.gelsight.com/gelsightmini/)
 
-Key features include:
-
-- **Unified API**: Interact with multiple types of touch sensors using a single, consistent API.
-- **Web Dashboard**: Manage sensors, record and replay data, and annotate data directly through a web interface.
-- **Easy Configuration**: Use YAML config files to quickly set up and manage sensors.
-
 ## Installation
 
-OpenTouch Interface requires Python 3.10 or higher and has been tested on Ubuntu 24.04.
-You can install it in one of two ways: either via `pip` or by cloning the repository.
+OpenTouch Interface requires Python 3.10+ (tested on Ubuntu 24.04).
 
-### Method 1: Install via `pip`
+#### Method 1: Install via `pip`
 
 ```bash
 pip install opentouch-interface
 ```
 
-### Method 2: Install via Cloning the Repository
+#### Method 2: From source
 
 ```bash
 git clone https://github.com/lasr-lab/opentouch-interface
 cd opentouch-interface
 pip install .
 ```
 
-## Connecting Sensors
+## Getting started
 
 You can connect touch sensors to the OpenTouch Interface in two main ways:
 
-### 1. Dashboard (Web Interface)
+### 1. Using the Dashboard (Web Interface)
 
-The dashboard provides an intuitive web-based interface. To start the dashboard, run:
+<p align="center">
+<img src="./docs/dashboard.gif" alt="dashboard" />
+</p>
 
+Start the dashboard. If you run into issues, try reconnecting your sensors and restarting the dashboard.
 ```bash
 opentouch-dashboard
 ```
 
-If you encounter any errors, try reconnecting your sensors and restarting the dashboard.
-
 #### Adding Sensors to the Dashboard
-
-You can add sensors to the dashboard by:
-
-1. **Manual Entry**: Enter sensor details directly in the dashboard.
-2. **YAML Configuration**: Use a YAML config file to define sensor groups and settings.
-
-Sensors are bundled in groups. Within a group **sensor names must be unique**.
-An example config file is provided as [`group.yaml`](examples/config/group.yaml).
-It is structured as follows:
+Add sensors either by manually entering details or by providing a YAML config file. For example, your YAML might look like:
 ```yaml
 group_name: Robotic hand  # Group name.
 path: test.touch          # File path where data should be saved (optional).
@@ -75,45 +64,27 @@ payload:      # List of input elements used for data annotations (optional).
   - ...       # e.g., text input
   - ...       # e.g., slider
 ```
+Sensors are bundled in groups. Within a group **sensor names must be unique**.
+An example config file is provided as [`group.yaml`](examples/config/group.yaml). There, you also find example configs of all supported sensors.
 
-There, you also find example configs of all supported sensors.
-
-The payload can be used for data annotations. You can use the following elements:
-- [Slider](https://docs.streamlit.io/develop/api-reference/widgets/st.slider)
-```yaml
-type: slider                    # Use 'slider'.
-label: Difficulty               # Label that will be displayed to the user.
-min_value: -10                  # Minimum value (int). Default: 0.
-max_value: 20                   # Maximum value (int). Default: 10.
-default: 8                      # Default value (int). Default: 0.
-```
-
-- [Text input](https://docs.streamlit.io/develop/api-reference/widgets/st.text_input)
-```yaml
-type: text_input                # Use 'text_input'.
-label: Grasped object           # Label that will be displayed to the user.
-default: apple                  # Default value (str). Default: "".
-```
+The payload can be used for data annotations. You can find an overview of supported widgets at [`payload.md`](examples/payload.md).
 
 ### 2. Using Code
 
-For users who prefer a programmatic approach, the OpenTouch Interface also allows direct interaction through code.
-
-Please have a look at our [`demo.py`](examples/demo.py) to see how to use it.
+For programmatic control, please refer to the [`demo.py`](examples/demo.py) example.
+- Run with the default config ([`digit.yaml`](examples/config/digit.yaml))
+    ```bash
+    python examples/simple/demo.py
+    ```
 
-```bash
-python examples/simple/demo.py
-```
-
-By default, this script uses the [`digit.yaml`](examples/config/digit.yaml) config file. You can specify a different config file via the terminal:
-
-```bash
-python examples/simple/demo.py --config-name gelsight.yaml
-```
+- Or specify a config file:
+    ```bash
+    python examples/simple/demo.py --config-name gelsight.yaml
+    ```
 ---
 
 ## Contribution
-If you want to contribute to OpenTouch Interface, you can find an explanation on how to do so [here](CONTRIBUTING.md).
+We welcome contributions! Pleaes check out our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
 
 ---
 

examples/payload.md

@@ -0,0 +1,61 @@
+This document contains a list of all Streamlit widgets the OpenTouch Interface supports for payload.
+Each widget's parameters are mandatory. The key `default` is the value of the widget when it first renders.
+It is equivalent to what the Streamlit documentation usually refers to as the `value`, `index` or `default`.
+
+#### [Slider](https://docs.streamlit.io/develop/api-reference/widgets/st.slider)
+```yaml
+type: slider                    # Widget type, always 'slider'.
+label: Select Age               # Description displayed to the user, must be unique.
+min_value: 0                    # Minimum value (float). Default: 0.
+max_value: 100                  # Maximum value (float). Default: 10.
+step: 1                         # Step size (float). Default: 1.
+default: 25                     # Initial slider value (float). Default: min_value.
+```
+
+#### [Text Input](https://docs.streamlit.io/develop/api-reference/widgets/st.text_input)
+```yaml
+type: text_input                # Widget type, always 'text_input'.
+label: Enter Your Name          # Description displayed to the user, must be unique.
+default: "John Doe"             # Initial text input value (str). Default: "".
+```
+
+#### [Checkbox](https://docs.streamlit.io/develop/api-reference/widgets/st.checkbox)
+```yaml
+type: checkbox                      # Widget type, always 'checkbox'.
+label: Accept Terms and Conditions  # Description displayed to the user, must be unique.
+default: false                      # Initial checkbox state (bool). Default: False.
+```
+
+#### [Multiselect](https://docs.streamlit.io/develop/api-reference/widgets/st.multiselect)
+```yaml
+type: multiselect                             # Widget type, always 'multiselect'.
+label: Choose Your Hobbies                    # Description displayed to the user, must be unique.
+options: ['Reading', 'Traveling', 'Cooking']  # List of available options (list of str). Default: [].
+default: ['Reading', 'Cooking']               # Default selected values; subset of options (list of str). Default: empty list
+```
+
+#### [Radio](https://docs.streamlit.io/develop/api-reference/widgets/st.radio)
+```yaml
+type: radio                           # Widget type, always 'radio'.
+label: Select Your Gender             # Description displayed to the user, must be unique.
+options: ['Male', 'Female', 'Other']  # List of available options (list of str). Default: [].
+default: 'Male'                       # Default value (str). Defaults to the first element in options.
+```
+
+#### [Selectbox](https://docs.streamlit.io/develop/api-reference/widgets/st.selectbox)
+```yaml
+type: selectbox                   # Widget type, always 'selectbox'.
+label: Choose Your Country        # Description displayed to the user, must be unique.
+options: ['USA', 'Canada', 'UK']  # List of available options (list of str). Default: [].
+default: 'USA'                    # Default value (str). Defaults to the first element in options or None if options are empty.
+```
+
+#### [Number Input](https://docs.streamlit.io/develop/api-reference/widgets/st.number_input)
+```yaml
+type: number_input              # Widget type, always 'number_input'.
+label: Enter Your Height (cm)   # Description displayed to the user, must be unique.
+min_value: 50                   # Minimum value (float). Default: 0.
+max_value: 250                  # Maximum value (float). Default: 100.
+step: 1                         # Step size (float). Default: 1.
+default: 170                    # Default value (float). Defaults to min_value.
+```

opentouch_interface/core/registries/class_registries.py

@@ -73,6 +73,10 @@ def get_config(cls, name: str):
     def get_configs(cls):
         return cls._widgets
 
+    @classmethod
+    def get_widget_names(cls):
+        return list(cls._widgets.keys())
+
 
 class ViewerClassRegistry:
     _viewers = {}

opentouch_interface/core/validation/streamlit/slider_config.py

@@ -0,0 +1,119 @@
+from pydantic import BaseModel, Field, model_validator
+from opentouch_interface.core.registries.class_registries import WidgetConfigRegistry
+
+
+@WidgetConfigRegistry.register_widget('slider')
+class SliderConfig(BaseModel):
+    """
+    Slider widget configuration.
+    """
+    type: str = Field(default='slider', description='Widget type')
+    label: str = Field(description='Short description')
+    min_value: float = Field(default=0, description='Defaults to 0')
+    max_value: float = Field(default=10, description='Defaults to 10')
+    step: float = Field(default=1, description='Defaults to 1')
+    default: float = Field(default=0, description='Defaults to 0')
+
+    @model_validator(mode='after')
+    def validate_model(self):
+        if self.default < self.min_value:
+            self.default = self.min_value
+        elif self.default > self.max_value:
+            self.default = self.max_value
+        return self
+
+
+@WidgetConfigRegistry.register_widget('text_input')
+class TextInputConfig(BaseModel):
+    """
+    Text input widget configuration.
+    """
+    type: str = Field(default='text_input', description='Widget type')
+    label: str = Field(description='Short description')
+    default: str = Field(default="", description='Defaults to empty string')
+
+
+@WidgetConfigRegistry.register_widget('checkbox')
+class CheckboxConfig(BaseModel):
+    """
+    Checkbox widget configuration.
+    """
+    type: str = Field(default='checkbox', description='Widget type')
+    label: str = Field(description='Short description')
+    default: bool = Field(default=False, description='Defaults to False')
+
+
+@WidgetConfigRegistry.register_widget('multiselect')
+class MultiselectConfig(BaseModel):
+    """
+    Multiselect widget configuration.
+    """
+    type: str = Field(default='multiselect', description='Widget type')
+    label: str = Field(description='Short description')
+    options: list[str] = Field(default=[], description='Comma separated list')
+    default: list[str] = Field(default=[], description='Subset of options')
+
+    @model_validator(mode='after')
+    def validate_model(self):
+        self.default = [option for option in self.default if option in self.options]
+        return self
+
+
+@WidgetConfigRegistry.register_widget('radio')
+class RadioConfig(BaseModel):
+    """
+    Radio button widget configuration.
+    """
+    type: str = Field(default='radio', description='Widget type')
+    label: str = Field(description='Short description')
+    options: list[str] = Field(default=[], description='Comma separated list')
+    default: str | None = Field(default=None, description='Defaults to first element')
+    horizontal: bool = Field(default=True, description='Defaults to horizontal')
+
+    @model_validator(mode='after')
+    def validate_model(self):
+        if not self.options:
+            self.options = []
+        if self.default is None or self.default not in self.options:
+            self.default = self.options[0] if self.options else None
+        return self
+
+
+@WidgetConfigRegistry.register_widget('selectbox')
+class SelectboxConfig(BaseModel):
+    """
+    Selectbox widget configuration.
+    """
+    type: str = Field(default='selectbox', description='Widget type')
+    label: str = Field(description='Short description')
+    options: list[str] = Field(default=[], description='Comma separated list')
+    default: str | None = Field(default=None, description='Defaults to first element')
+
+    @model_validator(mode='after')
+    def validate_model(self):
+        if not self.options:
+            self.options = []
+        if self.default is None or self.default not in self.options:
+            self.default = self.options[0] if self.options else None
+        return self
+
+
+@WidgetConfigRegistry.register_widget('number_input')
+class NumberInputConfig(BaseModel):
+    """
+    Number input widget configuration.
+    """
+    type: str = Field(default='number_input', description='Widget type')
+    label: str = Field(description='Short description')
+    min_value: float = Field(default=0, description='Defaults to 0')
+    max_value: float = Field(default=100, description='Defaults to 100')
+    step: float = Field(default=1, description='Defaults to 1')
+    default: float = Field(default=0, description='Defaults to min_value')
+
+    @model_validator(mode='after')
+    def validate_model(self):
+        if self.default < self.min_value:
+            self.default = self.min_value
+        elif self.default > self.max_value:
+            self.default = self.max_value
+        return self