iio-niri

KO | EN

gitlite — search

#hacktoberfest #typescript #golang #android #machine-learning #macos #windows #awesome #cli #vue #awesome-list #security #openai #open-source

(★ 58)

Listen to iio-sensor-proxy and updates Niri output orientation depending on the accelerometer orientation.

iio-niri Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<a id="readme-top"></a>

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

<div align="center">
<h3 align="center">IIO-Niri</h3>

Listen to iio-sensor-proxy and updates Niri output orientation depending on the accelerometer orientation.
 
 <a href="https://github.com/Zhaith-Izaliel/iio-niri?tab=readme-ov-file#usage">Explore the docs »</a>
 
 
 <a href="https://github.com/Zhaith-Izaliel/iio-niri/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
 &middot;
 <a href="https://github.com/Zhaith-Izaliel/iio-niri/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
 
</div>

<details>
 <summary>Table of Contents</summary>

 <ul>
 <li>
 <a href="#about-the-project">About The Project</a>
 <ul>
 <li><a href="#built-with">Built With</a></li>
 </ul>
 </li>
 <li>
 <a href="#getting-started">Getting Started</a>
 <ul>
 <li><a href="#prerequisites">Prerequisites</a></li>
 <li>
 <a href="#installation">Installation</a>
 <ul>
 <li><a href="#from-source">From source</a></li>
 <li><a href="#nix">Nix</a></li>
 <li><a href="#arch-linux-aur">Arch Linux (AUR)</a></li>
 </ul>
 </li>
 </ul>
 </li>
 <li>
 <a href="#usage">Usage</a>
 <ul>
 <li><a href="#communicating-with-a-running-instance-of-iio-niri">Communicating with a running instance of IIO-Niri</a></li>
 <li><a href="#generating-shell-completions">Generating Shell Completions</a></li>
 <li><a href="#nixos">NixOS</a></li>
 </ul>
 </li>
 <li><a href="#contributing">Contributing</a></li>
 <li><a href="#license">License</a></li>
 <li><a href="#contact">Contact</a></li>
 <li><a href="#acknowledgments">Acknowledgments</a></li>
 </ul>

</details>

## About The Project

Listen to IIO-Sensor-Proxy and updates Niri output orientation depending on the accelerometer orientation.

(<a href="#readme-top">back to top</a>)

### Built With

* [![Rust][Rust]][Rust-url]
* [![Nix][Nix]][Nix-url]

(<a href="#readme-top">back to top</a>)

## Getting Started

### Prerequisites

IIO-Niri requires the Rust Compiler if you plan to compile it, you will also need Cargo to build the project and DBus dependencies.
* `rustc` ⩾ 1.91.1
* `cargo` ⩾ 1.91.1
* `pkg-config` ⩾ 0.29.2
* `libdbus` ⩾ 1.14.10

At runtime, the program relies on [IIO-Sensor-Proxy][IIO-Sensor-Proxy-Url] to fetch updates on the accelerometer. Make sure it is running alongside IIO-Niri.

If you intend to work with Nix:

* `nix` ⩾ 2.31.2 with [flake support](https://wiki.nixos.org/wiki/Flake).

### Installation

#### From source

1. Clone the repo
   ```sh
   git clone https://github.com/Zhaith-Izaliel/iio-niri.git
   ```
2. Install Cargo and Rustc from your package manager.
3. Build IIO-Niri with Cargo in release mode 
   ```sh
   cargo build --release
   ```
4. An executable for IIO-Niri will be available in `target/release/iio-niri`

#### Nix

IIO-Niri is officially available in Nixpkgs under `pkgs.iio-niri` and has a corresponding module
at `services.iio-niri`. This flake exists purely for bleeding edge updates and
for historical reason.

The maintainer of the project is also the maintainer of the package and module
upstream (a.k.a. yours truly).

If you prefer, you can install it with the provided flake like so:

1. Import the project in your flake inputs
   ```nix
   inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    iio-niri = {
      url = "github:Zhaith-Izaliel/iio-niri";
      inputs.nixpkgs.follows = "nixpkgs";
    };
   };
   ```
2. You can then install it from `inputs.iio-niri.packages.${system}.default` where `${system}` is your system descriptor. For Linux, usually `x86_64-linux`.

#### Arch Linux (AUR)

There are two primary ways to install IIO-Niri via the Arch User Repository (AUR):

##### Via Preferred AUR Helper (Yay or Paru)

1. Simply enter one of the two commands below, depending on your installed pacman wrapper:

```
  $ yay -S iio-niri
  
  $ paru -S iio-niri
```

##### Via makepkg (default)

2. Alternatively, simply clone the AUR repository and install using makepkg:

```
  git clone https://aur.archlinux.org/iio-niri.git
  cd iio-niri
  makepkg -si
```

**Please Note:** The AUR package for this project is maintained by the
community, and not by the developer. While it is sourced directly from the
master branch of the developer's GitHub repository, users should always exercise
discretion and caution when installing packages via the AUR.

(<a href="#readme-top">back to top</a>)

## Usage

Use `iio-niri -h` to see a short summary of available options and `iio-niri --help` to see a detailed explanation of every available options.

At runtime, the program relies on [IIO-Sensor-Proxy][IIO-Sensor-Proxy-Url] to fetch updates on the accelerometer. Make sure it is running alongside IIO-Niri.

Then start IIO-Niri in `listen` mode with Niri:

```kdl
spawn-at-startup "iio-niri" "listen" "--monitor" "eDP-1"
```

You can also remap the orientation you want your screen to have based on what the sensor detects by passing `--transform <normal> <left-up> <bottom-up> <right-up>`. Possible values include `normal` (0°), `90` `180` `270` and `keep` (keeps whatever was previously used). A common usecase is disabling portrait orientations: `--transform normal keep 180 keep`

### Communicating with a running instance of IIO-Niri

IIO-Niri generates its own socket for Inter Process Communication (IPC). You can use the `msg` sub-command to send requests to the IPC.

For example:

```shell
iio-niri msg ping # Prints the received response as a JSON object.
```

#### Implementing your own IPC client

It is also possible, albeit not recommended, to communicate directly with the socket sending your own JSON formatted strings.

Under the hood, the `msg` sub-command sends a request in the form:

```json
{
 "action": <action_string>,
 "arg": <argument for the action, can be null>
}
```

Refer to the [IPC source code](https://github.com/Zhaith-Izaliel/iio-niri/blob/be812d237f1f69775947a1afef813ed956943907/src/ipc.rs#L84) for a list of available `action_string` and what type of argument each action takes.

When a request is received and processed, IIO-Niri returns a response as a JSON formatted string, in the form:

```json
{
 "status": <either "ok" or "error">,
 "response": <a string if the status is "error" or the value returned by the action, usually the old value after a state change>
}
```

To know what is the `response` field when a request succeeds (i.e. `status = "ok"`), please refer to the `iio-niri msg --help` and its sub-commands.

### Generating Shell Completions

You can generate shell completions script by using `iio-niri completions <shell>`. The completions script will print to the standard output.

### NixOS

The provided flake offers a NixOS module to install IIO-Niri as well as an overlay.

Here is a simple example on how to install both the overlay and the module in
your NixOS configuration:

```nix
outputs = { self, nixpkgs, iio-niri }: {
  # replace 'joes-desktop' with your hostname here.
  nixosConfigurations.joes-desktop = nixpkgs.lib.nixosSystem {
    system = "x86_64-linux";
    modules = [
      iio-niri.nixosModules.default
      # ---Snip---
      # Add your own modules here
      # ---Snip---

# Example to add the overlay to Nixpkgs:
      {
        nixpkgs = {
          overlays = [
            iio-niri.overlays.default
          ];
        };
      }
    ];
  };
};
```

Then enable the module.

```nix
{...}: {
  services.iio-niri = {
    enable = true;

extraArgs = [
      "--monitor"
      "eDP-1"
    ];
  };
}
```

See [the module documentation][module-doc] for more info.

(<a href="#readme-top">back to top</a>)

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

> [!IMPORTANT]
> We do not allow AI generated or AI assisted contributions, as they usually show a lack of proper understanding of the project source code and makes maintenance harder in the long run.

### How to make a pull request

1. Fork the Project
2. Commit your Changes (`git commit -m 'feat: add some amazing-feature'`)
  * Your commit messages must follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
3. Push to your `master` branch (`git push origin master`)
4. Open a Pull Request on `master`

(<a href="#readme-top">back to top</a>)

### Top contributors:

## License

Distributed under the MIT License. See `LICENSE.md` for more information.

(<a href="#readme-top">back to top</a>)

## Contact

Zhaith Izaliel - [@zhaith-izaliel.bsky.social](https://bsky.app/profile/zhaith-izaliel.bsky.social)

Project Link: [https://github.com/Zhaith-Izaliel/iio-niri](https://github.com/Zhaith-Izaliel/iio-niri)

(<a href="#readme-top">back to top</a>)

## Acknowledgments

* [Best-README-Template](https://github.com/othneildrew/Best-README-Template) for this README
* [IIO-Hyprland](https://github.com/JeanSchoeller/iio-hyprland) for the know how on handling DBus requests and signals for IIO-Sensor-Proxy
* [IIO-Sensor-Proxy][IIO-Sensor-Proxy-Url] for the proxy to handle accelerometer requests for this program

(<a href="#readme-top">back to top</a>)

[contributors-shield]: https://img.shields.io/github/contributors/Zhaith-Izaliel/iio-niri.svg?style=for-the-badge
[contributors-url]: https://github.com/Zhaith-Izaliel/iio-niri/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Zhaith-Izaliel/iio-niri.svg?style=for-the-badge
[forks-url]: https://github.com/Zhaith-Izaliel/iio-niri/network/members
[stars-shield]: https://img.shields.io/github/stars/Zhaith-Izaliel/iio-niri.svg?style=for-the-badge
[stars-url]: https://github.com/Zhaith-Izaliel/iio-niri/stargazers
[issues-shield]: https://img.shields.io/github/issues/Zhaith-Izaliel/iio-niri.svg?style=for-the-badge
[issues-url]: https://github.com/Zhaith-Izaliel/iio-niri/issues
[license-shield]: https://img.shields.io/github/license/Zhaith-Izaliel/iio-niri.svg?style=for-the-badge
[license-url]: https://github.com/Zhaith-Izaliel/iio-niri/blob/master/LICENSE.md

[Rust]: https://img.shields.io/badge/Rust-B7400F?style=for-the-badge&logo=rust&logoColor=white
[Rust-url]: https://www.rust-lang.org/
[Nix]: https://img.shields.io/badge/nix-0B1120?style=for-the-badge&logo=nixos
[Nix-url]: https://nixos.org/

[IIO-Sensor-Proxy-Url]: https://gitlab.freedesktop.org/hadess/iio-sensor-proxy/
[module-doc]: https://github.com/Zhaith-Izaliel/iio-niri/blob/master/MODULE-DOC.md

iio-niri

iio-niri Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

iio-niri

iio-niri Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README