hayodea/salmanoff
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Docs: rename harikoff=>salmanoff

Browse Source
This commit is contained in:
Hayodea Hekol
2025-07-22 06:03:47 -04:00
parent d6a0b0301e
commit 9c16aeeb55
3 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/deviceSpec.md
+16 -16
View File
@@ -2,9 +2,9 @@
## Attaching sensors:
Sensors are input devices to Harikoff. Harikoff will perceive them as
Sensors are input devices to Salmanoff. Salmanoff will perceive them as
perceptual inputs -- like your own sense organs. For example, if you attach a
camera as a sensor, harikoff will experience it in the same way that you
camera as a sensor, salmanoff will experience it in the same way that you
experience the visual sense data from your eyes.
## Implexors:
@@ -26,7 +26,7 @@ sensor-type|implexor|api(api-params)|provider(provider-params)|deviceselector
* `implexor` is the name of the implexor algorithm that should be used with
the data that is provided by the `provider` via the `api`.
* `api` is the interface that the provider uses to export perceptual data for
harikoff to read. Harikoff will run the `implexor` algorithm on the data
salmanoff to read. Salmanoff will run the `implexor` algorithm on the data
from this `api`. The `api-param` in parentheses may be omitted, in which
case the parentheses will be empty, but the parentheses must always be
written out.
@@ -58,8 +58,8 @@ Some examples follow:
+edev|visual-implexor|wayland()|wayland(server-socket)|window0
```
Connect to the Wayland server that's listening on `server-socket`, using the
`wayland` api. Ask that Wayland server to give harikoff read-access to all of
the frames composited into the window buffer for `window0`. Use harikoff's
`wayland` api. Ask that Wayland server to give salmanoff read-access to all of
the frames composited into the window buffer for `window0`. Use salmanoff's
`visual-implexor` to implex from that `window0`'s compositor data.
### To attach a window manager's entire rendered desktop:
@@ -70,8 +70,8 @@ In most cases, this is basically the same as attempting to attach all of the
underlying GFX server's output.
Connect to the Wayland server that's listening on `listen-socket`, using the
`wayland` api. Ask that Wayland server to give harikoff read-access to the
entire compositor framebuffer. Use harikoff's `visual-implexor` to implex from
`wayland` api. Ask that Wayland server to give salmanoff read-access to the
entire compositor framebuffer. Use salmanoff's `visual-implexor` to implex from
that Wayland server's compositor data.
### To attach all of an Xorg server's gfx output to all screens:
@@ -80,8 +80,8 @@ that Wayland server's compositor data.
```
Connect to the Xorg server that's listening on `listen-socket`, using the `x11`
api. Ask that Xorg server to let Harikoff read out all of the frames written
out to all screens. Use harikoff's `visual-implexor` to implex from the
api. Ask that Xorg server to let Salmanoff read out all of the frames written
out to all screens. Use salmanoff's `visual-implexor` to implex from the
server's gfx framebuffer data.
In most cases, this is basically the same as attempting to attach all of the
@@ -96,8 +96,8 @@ WM's output.
+edev|visual-implexor|x11()|xorg(listen-socket)|:0
```
Connect to the Xorg server that's listening on `listen-socket`, using the `x11`
api. Ask that Xorg server to let Harikoff read out all of the frames written
out to display `:0`. Use harikoff's `visual-implexor` to implex from display
api. Ask that Xorg server to let Salmanoff read out all of the frames written
out to display `:0`. Use salmanoff's `visual-implexor` to implex from display
`:0`'s framebuffer data.
* Implementation note:
@@ -109,7 +109,7 @@ out to display `:0`. Use harikoff's `visual-implexor` to implex from display
+edev|visual-implexor|v4l()|linux()|/dev/video0
```
We specify that we want to use the `linux` kernel's loaded driver to connect
to communicate with `/dev/video0`, via the `Video4Linux` API. We want harikoff
to communicate with `/dev/video0`, via the `Video4Linux` API. We want salmanoff
to use the `visual-implexor` algorithm to implex from `/dev/video0`'s data.
If `/dev/video0` is already consumed by another process, this may likely fail.
@@ -134,17 +134,17 @@ Use the `thermal-zone` SysFS API provided by `linux` to connect to the sensor
## Attaching actuators:
Actuators are Harikoff's way of enacting changes in the external world.
They're like your libs, or your mouth. Actuators enable harikoff to write
Actuators are Salmanoff's way of enacting changes in the external world.
They're like your libs, or your mouth. Actuators enable salmanoff to write
outputs to the world outside.
### Wilzors:
Actuator devices are analogous to your body's limbs. Harikoff controls these
Actuator devices are analogous to your body's limbs. Salmanoff controls these
by using `wilzor` algorithms. Wilzor is a contraction of **Wil**lpower
Actuat**Or** but with a 'Z' in the middle to make it sound cooler. Different
types of devices will require different wilzor algorithms. You need to know
what type of wilzor algorithm needs to be used to enable harikoff to control
what type of wilzor algorithm needs to be used to enable salmanoff to control
your actuator device.
The general format for an actuator's device spec is: