labthings / labthings/labthings-fastapi

Add a way to attach more metadata to affordances and/or things

Open
#253 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
9
Forks
4
PR merge metrics
No merged PRs in 30d

Description

At the moment, the implementation of dynamic UI in OpenFlexure needs more metadata for each affordance than is currently included in the Thing Description. If we could specify things like button text (for an action) or whether we should read back the value with a delay after setting (for a property) that feels like the sort of thing that would sit naturally in the affordance's metadata in the TD.

I think this makes more sense if the Thing Description can depend on the Thing instance - but I also think that's a good idea anyway because of thing_slot related affordances.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the Thing Description represents affordances and how thing_slot-related affordances are handled. Define how an instance-dependent TD would carry metadata such as action button text and delayed property readback, then confirm that dynamic UI consumers can use it consistently. Done means the required affordance metadata and instance dependency are specified and supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, python
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.