Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gtxaspec/thingino-button

Last synced: 24 days ago
JSON representation

Host: GitHub
URL: https://github.com/gtxaspec/thingino-button
Owner: gtxaspec
Created: 2024-07-31T18:18:04.000Z (3 months ago)
Default Branch: master
Last Pushed: 2024-08-01T18:48:19.000Z (3 months ago)
Last Synced: 2024-08-01T23:08:21.086Z (3 months ago)
Language: C
Size: 18.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Thingino-Button

`thingino-button` is a simple program designed to monitor input events from a specified device and execute corresponding commands based on the configuration. It is primarily aimed at embedded systems where specific actions need to be triggered by pressing, releasing, or holding buttons.

## Features

- Monitor an input device for key events.
- Execute different commands on key press, release, or timed hold.
- Configurable through a simple configuration file.
- Supports running as a daemon or in silent mode.
- Basic key support for `KEY_ENTER` and keys `0-9`. More keys can be easily added by modifying the source code.

## Requirements

- A Linux-based system with access to the input device (e.g., `/dev/input/event0`).

## Installation

1. **Clone the Repository:**
```sh
git clone https://github.com/gtxaspec/thingino-button.git
cd thingino-button
```

2. **Compile the Program:**
To compile the program, you can use the provided Makefile. If you are cross-compiling, set the `CROSS_COMPILE` variable.
```sh
make CROSS_COMPILE=mipsel-linux-
```

This will generate the `thingino-button` executable.

## Usage

1. **Create a Configuration File:**

Create a file named `/etc/thingino-button.conf` with the following format:
```ini
# Device to monitor
DEVICE=/dev/input/event0

# Key action mappings
# Format: KEY_
KEY_ENTER PRESS 0 /bin/command1
KEY_ENTER RELEASE 0 /bin/command2
KEY_ENTER TIMED 0.1 /bin/command-timed press
KEY_ENTER TIMED 3 /bin/command-timed
KEY_ENTER TIMED 5 /bin/command-timed
KEY_ENTER TIMED 20 /bin/command-timed
```

2. **Run the Program:**

You can run the program directly or with optional flags:
```sh
./thingino-button [-s] [-d] [input_device]
```

- `-s`: Run in silent mode, logging to syslog.
- `-d`: Run as a daemon, logging to syslog.
- `input_device`: Optional input device path, overrides the config file.

Example:
```sh
./thingino-button -s /dev/input/event1
```

## Configuration File Format

The configuration file should be located at `/etc/thingino-button.conf` and follows this format:

```ini
# Device to be monitored for input events
DEVICE=/dev/input/event0

# Key action mappings
# Format: KEY_
# - : Name of the key (e.g., ENTER, 1, 2, etc.)
# - : Type of action (PRESS, RELEASE, TIMED, TIMED_FIRE)
# - : Time in seconds for TIMED, TIMED_FIRE actions (use 0 for PRESS and RELEASE)
# - : Command to execute when the action occurs

# Example mappings:
KEY_ENTER PRESS 0 /bin/command1
KEY_ENTER RELEASE 0 /bin/command2
KEY_ENTER TIMED 0.1 /bin/command-timed press
KEY_ENTER TIMED 3 /bin/command-timed
KEY_ENTER TIMED 5 /bin/command-timed
KEY_ENTER TIMED 20 /bin/command-timed
```

## Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any enhancements or bug fixes.

## License

This project is licensed under the MIT License.