Skip to content

hal: C++ API (hal.hh) and pybind11 bindings on the new HAL API #4251

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

Open
grandixximo wants to merge 3 commits into
base: master
Choose a base branch
from
+2,554 −2,026
Open

hal: C++ API (hal.hh) and pybind11 bindings on the new HAL API #4251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
20d080f
hal: C++ API (hal.hh) and pybind11 bindings on the 64-bit HAL API
grandixximo Oct 15, 2026
fba9f00
hal: _hal is built on hal.hh, replacing halmodule.cc and halpp
grandixximo Nov 9, 2026
8280162
hal: review follow-ups for hal.hh and its tests
grandixximo Nov 9, 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
23 changes: 0 additions & 23 deletions docs/src/config/python-hal-interface.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -804,29 +804,6 @@ hal.query.threads() -> dict::
----
See xref:halquerythread[`hal.query.thread()`] for description of thread dictionary details.

== Class `hal.shm`
The `shm` class is an interface to create and manage shared memory segments.

The `shm` class **should be considered __experimental__** and may or may not work as intended.
[WARNING]
====
Do not rely on this class.
It may be removed in future releases.
====

=== shm methods

shm = hal.shm(_comp_:object, _key_:int, _size_:int)::
Allocate a _size_ sized shared memory segment with ID _key_.

shm.getbuffer()::
Returns a Python `memoryview` object of the shared memory segment.

shm.setsize()::
This is non-functional.
**Do not use.**
You cannot increase or decrease the shared memory segment's size once it is created.

== HAL Port pipes
A HAL port is a byte-oriented pipe that streams bytes from the writer to the reader.
It may be used to transport data between real-time and non-real-time in either direction.
Expand Down
Loading