Skip to content

Acacia I2C, Serial and Timer + new Python tooling #751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
omeh-a wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Acacia I2C, Serial and Timer + new Python tooling #751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
959f432
(wip) Timer and i2c acacia adaptation
omeh-a Jun 25, 2026
a55c47c
Updated ina219 and bus scan i2c examples to use acacia
omeh-a Jul 2, 2026
013449b
Lint Python with Acacia additions
omeh-a Jul 3, 2026
6d06dfb
Update signatures to put SDF first for Acacia
omeh-a Jul 12, 2026
de0f706
Extract per-board / x86 metaprogram hacks to class.py
omeh-a Jul 13, 2026
55b8d7b
Add I2CAddress type and I2C address decoding for I2C class
omeh-a Jul 14, 2026
f8215fb
Refactor sDDFDeviceClass to initialise configstructs at correct time,…
omeh-a Aug 6, 2026
1d5b5c5
Added blk support using acacia
omeh-a Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions acacia_sddf/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Copyright 2026, UNSW

@midnightveil midnightveil Aug 4, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this should be under acacia_sddf. It's not really clear what acacia is for a user. I think the timer/serial classes should either live in the appropriate serial/ or timer/ directory and helpers under tools/meta or tools/acacia.

@omeh-a omeh-a Aug 4, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a blunt reason for this: it means that we only need one Python import and it means that each driver class doesn't need to abuse importlib to find the others. I really think it's fine to have end users learn what Acacia is, given that they have to install it to use the sDDF. I did it as you suggest initially and it made things horrible. I'm really not eager to change this.

@midnightveil midnightveil Aug 5, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think having to set up PYTHONPATH (which you can do entirely in the Makefile) is that bad. If you want just one import you can still do that without separating the components from the rest of the components, you just have some path-mangling.

The other thing is to consider external users: LionsOS, for instance, could just do "import sddf.timer" if it's located in the timer folder, whereas with this way you need to either do "import sddf.acacia_sddf.timer" or have top level exports (not necessary if your project structure follows python module structure, no need for init.py etc). They'd have to put sDDF in their PythonPath but that's fine and reasonable.

tldr; no, I disagree.

@omeh-a omeh-a Aug 5, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users of anything will be using acacia anyway though? How can a user of acacia who must be using it in their metaprogram not already know what acacia is? Making the entire sDDF tree a python module just complicates things. The only functional diff from what you're describing is whether the module is called sddf or acacia_sddf. We can rename acacia_sddf to just sddf if it matters ... I personally think it's inconsequential, but I also really think it's worse for code organisation to scatter the python through the source tree.

@omeh-a omeh-a Aug 5, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sidenote: I don't think we will need to import sddf.acacia_sddf.blah either? We can do this exactly as it is done in the metaprogram and not make a top level sDDF module

# SPDX-License-Identifier: BSD-2-Clause

from .i2c import sDDFI2C
from .timer import sDDFTimer
from .serial import sDDFSerial
from .blk import sDDFBlk
from .sddf import sDDFDriverClass, sDDFDriverConfig, sDDFDriverManifest
from .board import BOARDS, Board
Loading
Loading