labthings / labthings/labthings-fastapi

Support for Events

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

Nobody has claimed this yet.

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

Description

Is your feature request related to a problem? Please describe.
Sometimes, it's desirable to be able to push notifications from the server to a client, without having a well-defined Data Property to observe.

Describe the solution you'd like
Things should be able to define Events which can be observed. Each event should have a name, a description, and a schema.

Additional context
The WoT standard defines three types of "interaction affordance": properties, actions, and events. Events are missing from LabThings and there's now at least one concrete use case.

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

No files or tests are named. Start by reviewing how Things currently expose properties and actions, then trace the WoT interaction-affordance support; done means Things can define observable Events with a name, description, and schema that push notifications to clients.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.