wip (#323)

* wip

* ui dev

* a lot of ui dev

* more features working

* more development

* remove redundant css rules

* update bootstrap deps

* more dev

* a lot of new stuff

* add markdown background gradients

* attempt to set initial focus

* minor border tweaks

* auto focus channel filter when changing tab

* focus channel table when toggling

* auto focus tab filter on open

* more focus scenarios

* use browser's suggestion for 'passive'

* more features

* add title to checkbox

* wip

* sa fixes

* comment

* fixes for firefox

* minor fixes

* use new vcorelib def and fifo

* fix minor issue for touch interface

* remove source mapping lines

* add websocket restarting

* upgrades for markdown dir stuff

* fix markdown page gradients

* finish unit testing

* sa

Author: vkottler

.github/workflows/python-package.yml

@@ -78,7 +78,7 @@ jobs:
 
       - run: |
           mk python-release owner=libre-embedded \
-                            repo=runtimepy version=5.14.2
+                            repo=runtimepy version=5.15.0
         if: |
           matrix.python-version == '3.12'
           && matrix.system == 'ubuntu-latest'

README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.2.3
-    hash=d3dcde1ba35cb14decfc6881b6a2d4e6
+    hash=db8f45762873863c99d4d7d8f996d2fb
     =====================================
 -->
 
-# runtimepy ([5.14.2](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.15.0](https://pypi.org/project/runtimepy/))
 
 [![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
 ![Build Status](https://github.com/libre-embedded/runtimepy/workflows/Python%20Package/badge.svg)

config

@@ -0,0 +1,9 @@
+---
+includes:
+  - config/python/ifgen/settings.yaml
+  - config/python/ifgen/sample.yaml
+  - package://ifgen/plugins/struct_receiver.yaml
+
+cpp_dir: []
+python_dir: [tests]
+namespace: [tests]

ifgen.yaml

@@ -8,8 +8,8 @@ time_command: true
 
 requirements:
   - aiofiles
-  - vcorelib>=3.6.0
-  - svgen>=0.7.12
+  - vcorelib>=3.6.2
+  - svgen>=0.8.0
   - websockets
   - psutil
   - "windows-curses; sys_platform == 'win32' and python_version < '3.12'"

local/configs/package.yaml

@@ -1,5 +1,5 @@
 ---
 major: 5
-minor: 14
-patch: 2
+minor: 15
+patch: 0
 entry: runtimepy

local/variables/package.yaml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta:__legacy__"
 
 [project]
 name = "runtimepy"
-version = "5.14.2"
+version = "5.15.0"
 description = "A framework for implementing Python services."
 readme = "README.md"
 requires-python = ">=3.12"

pyproject.toml

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.2.3
-# hash=f2469e97ed5a3a48c5347357f12c3554
+# hash=58f166da9bc0561c671ef04c334d585d
 # =====================================
 
 """
@@ -10,7 +10,7 @@
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.14.2"
+VERSION = "5.15.0"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

runtimepy/__init__.py

@@ -29,10 +29,7 @@
 from runtimepy.primitives.int import Uint64 as _Uint64
 from runtimepy.primitives.types import AnyPrimitiveType as _AnyPrimitiveType
 from runtimepy.registry.item import RegistryItem as _RegistryItem
-
-Literal = int | float | bool
-Default = _Optional[Literal]
-Controls = dict[str, Literal | dict[str, Literal]]
+from runtimepy.ui.controls import Controls, Default
 
 
 class Channel(_RegistryItem, _EnumMixin, _Generic[_T]):

runtimepy/channel/__init__.py

@@ -3,10 +3,12 @@
 """
 
 # built-in
+from contextlib import ExitStack as _ExitStack
 from typing import Iterator as _Iterator
+from typing import Optional
+from typing import cast as _cast
 
 # internal
-from runtimepy.channel import Default as _Default
 from runtimepy.channel.environment.array import (
     ArrayChannelEnvironment as _ArrayChannelEnvironment,
 )
@@ -19,6 +21,23 @@
 from runtimepy.channel.environment.telemetry import (
     TelemetryChannelEnvironment as _TelemetryChannelEnvironment,
 )
+from runtimepy.codec.protocol import Protocol as _Protocol
+from runtimepy.codec.protocol.base import FieldSpec as _FieldSpec
+from runtimepy.primitives import AnyPrimitive
+from runtimepy.ui.controls import Controls, Default, bit_slider
+
+
+def regular_channel_controls(
+    primitive: AnyPrimitive, commandable: bool
+) -> Optional[Controls]:
+    """Get channel controls for a regular primitive."""
+
+    controls = None
+
+    if commandable and primitive.kind.is_integer and primitive.kind.bits <= 32:
+        controls = bit_slider(primitive.kind.bits, primitive.kind.signed)
+
+    return controls
 
 
 class ChannelEnvironment(
@@ -29,13 +48,85 @@ class ChannelEnvironment(
 ):
     """A class integrating channel and enumeration registries."""
 
+    def register_protocol(
+        self, protocol: _Protocol, commandable: bool
+    ) -> None:
+        """Register protocol elements as named channels and fields."""
+
+        # Register any new enumerations.
+        self.enums.register_from_other(protocol.enum_registry)
+
+        # need to handle defaults
+
+        for item in protocol.build:
+            # Handle regular primitive fields.
+            if isinstance(item, _FieldSpec):
+                if item.is_array():
+                    assert item.array_length is not None
+                    with self.names_pushed(item.name):
+                        for idx in range(item.array_length):
+                            primitive = protocol.get_primitive(
+                                item.name, index=idx
+                            )
+                            self.channel(
+                                str(idx),
+                                kind=primitive,
+                                commandable=commandable,
+                                enum=item.enum,
+                                controls=regular_channel_controls(
+                                    primitive, commandable
+                                ),
+                            )
+                else:
+                    primitive = protocol.get_primitive(item.name)
+                    self.channel(
+                        item.name,
+                        kind=primitive,
+                        commandable=commandable,
+                        enum=item.enum,
+                        controls=regular_channel_controls(
+                            primitive, commandable
+                        ),
+                    )
+
+            # Handle nested protocols.
+            elif isinstance(item[0], str):
+                name = item[0]
+                candidates = protocol.serializables[name]
+                if isinstance(candidates[0], _Protocol):
+                    with self.names_pushed(name):
+                        for idx, candidate in enumerate(candidates):
+                            with _ExitStack() as stack:
+                                # Enter array-index namespace if applicable.
+                                if len(candidates) > 1:
+                                    stack.enter_context(
+                                        self.names_pushed(str(idx))
+                                    )
+
+                                self.register_protocol(
+                                    _cast(_Protocol, candidate), commandable
+                                )
+
+            # Handle bit fields.
+            elif isinstance(item[0], int):
+                fields = protocol.get_fields(item[0])
+                for field in fields.fields.values():
+                    field.commandable = commandable
+                    # add sliders for non enum non bool (check enum fields too)
+                self.add_fields(
+                    item[1],
+                    fields,
+                    commandable=commandable,
+                    controls=bit_slider(fields.raw.kind.bits, False),
+                )
+
     def search_names(
         self, pattern: str, exact: bool = False
     ) -> _Iterator[str]:
         """Search for names belonging to this environment."""
         yield from self.channels.names.search(pattern, exact=exact)
 
-    def set_default(self, key: str, default: _Default) -> None:
+    def set_default(self, key: str, default: Default) -> None:
         """Set a new default value for a channel."""
 
         chan, _ = self[key]

runtimepy/channel/environment/__init__.py

@@ -28,6 +28,7 @@
 from runtimepy.mapping import EnumMappingData as _EnumMappingData
 from runtimepy.primitives import ChannelScaling, Primitive
 from runtimepy.primitives import Primitivelike as _Primitivelike
+from runtimepy.primitives.field.fields import BitFields as _BitFields
 from runtimepy.registry.name import RegistryKey as _RegistryKey
 
 
@@ -74,10 +75,22 @@ def channel(
 
         # Keep track of any new enum channels.
         if enum is not None:
-            self.channel_enums[result] = self.enums[enum]
+            runtime = self.enums[enum]
+            self.channel_enums[result] = runtime
+            if runtime.default:
+                self[name] = runtime.default
 
         return self[name]
 
+    def add_fields(
+        self, name: str, fields: _BitFields, **channel_kwargs
+    ) -> None:
+        """Add bit fields to this channel environment."""
+
+        self.channel(name, kind=fields.raw, **channel_kwargs)
+        with self.names_pushed(name):
+            self.fields.add(fields, namespace=self._namespace, track=True)
+
     def int_channel(
         self,
         name: str,
@@ -171,6 +184,7 @@ def enum(
         items: _EnumMappingData = None,
         namespace: _Namespace = None,
         primitive: str = DEFAULT_ENUM_PRIMITIVE,
+        **kwargs,
     ) -> _RuntimeEnum:
         """Create a new enum from the environment."""
 
@@ -179,6 +193,7 @@ def enum(
             kind=kind,
             items=items,
             primitive=primitive,
+            **kwargs,
         )
         assert result is not None, f"Can't create enum '{name}'!"
         return result

runtimepy/channel/environment/create.py

@@ -33,6 +33,7 @@ def sample_int_enum(
             "nine": 9,
             "ten": 10,
         },
+        default="three",
     )
 
 
@@ -99,6 +100,7 @@ def sample_fields(env: ChannelEnvironment, enum: str = "SampleEnum") -> None:
                 1,
                 commandable=True,
                 description="Sample bit flag.",
+                default=True,
             )
         )
         env.add_field(
@@ -109,13 +111,19 @@ def sample_fields(env: ChannelEnvironment, enum: str = "SampleEnum") -> None:
                 2,
                 enum=enum if enum else None,
                 commandable=True,
+                default="three" if enum else 3,
                 description="Sample bit field.",
             )
         )
         env.add_field(
             BitField(
-                env.namespace(name="field2"), prim, 4, 4, commandable=True
-            )
+                env.namespace(name="field2"),
+                prim,
+                4,
+                4,
+                default=0,
+                commandable=True,
+            ).set_slider()
         )
 
 

runtimepy/channel/environment/sample.py

@@ -16,7 +16,6 @@
 # internal
 from runtimepy.channel import AnyChannel as _AnyChannel
 from runtimepy.channel import Channel as _Channel
-from runtimepy.channel import Default as _Default
 from runtimepy.channel.event.header import PrimitiveEventHeader
 from runtimepy.codec.protocol import Protocol
 from runtimepy.mapping import DEFAULT_PATTERN
@@ -29,7 +28,7 @@
 from runtimepy.registry import Registry as _Registry
 from runtimepy.registry.name import NameRegistry as _NameRegistry
 from runtimepy.registry.name import RegistryKey as _RegistryKey
-from runtimepy.ui.controls import Controlslike, normalize_controls
+from runtimepy.ui.controls import Controlslike, Default, normalize_controls
 
 
 class ChannelNameRegistry(_NameRegistry):
@@ -92,7 +91,7 @@ def channel(
         enum: _RegistryKey = None,
         scaling: ChannelScaling = None,
         description: str = None,
-        default: _Default = None,
+        default: Default = None,
         controls: Controlslike = None,
         **kwargs,
     ) -> _Optional[_AnyChannel]: