{"id":18936605,"url":"https://github.com/spacehuhntech/huhnitor","last_synced_at":"2025-04-05T21:10:22.355Z","repository":{"id":42366154,"uuid":"266790566","full_name":"SpacehuhnTech/Huhnitor","owner":"SpacehuhnTech","description":"Intergalactic serial monitor for ESP8266 Deauther","archived":false,"fork":false,"pushed_at":"2024-05-15T03:12:31.000Z","size":158,"stargazers_count":335,"open_issues_count":4,"forks_count":46,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-03-29T20:08:02.989Z","etag":null,"topics":["deauther","hacktoberfest","monitor","serial","terminal"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpacehuhnTech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"spacehuhntech","patreon":null,"open_collective":null,"ko_fi":"spacehuhn","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-05-25T13:47:05.000Z","updated_at":"2025-03-21T02:56:56.000Z","dependencies_parsed_at":"2024-12-16T05:05:59.530Z","dependency_job_id":"e5c0c152-7b00-4380-945c-90b55192c7e1","html_url":"https://github.com/SpacehuhnTech/Huhnitor","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpacehuhnTech%2FHuhnitor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpacehuhnTech%2FHuhnitor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpacehuhnTech%2FHuhnitor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpacehuhnTech%2FHuhnitor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpacehuhnTech","download_url":"https://codeload.github.com/SpacehuhnTech/Huhnitor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247399885,"owners_count":20932880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deauther","hacktoberfest","monitor","serial","terminal"],"created_at":"2024-11-08T12:08:14.752Z","updated_at":"2025-04-05T21:10:22.328Z","avatar_url":"https://github.com/SpacehuhnTech.png","language":"Rust","funding_links":["https://github.com/sponsors/spacehuhntech","https://ko-fi.com/spacehuhn"],"categories":[],"sub_categories":[],"readme":"# Huhnitor\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Huhnitor Logo\" src=\"img/logo.png\" width=\"200\"\u003e\n  \u003cbr\u003e\n  An intergalactic serial monitor for the \u003ca href=\"https://github.com/SpacehuhnTech/esp8266_deauther/tree/v3\"\u003eESP8266 Deauther v3\u003c/a\u003e\n  \u003cbr\u003e\n  \u003cimg src=\"https://github.com/SpacehuhnTech/Huhnitor/workflows/Rust/badge.svg?branch=master\" alt=\"Rust badge\"\u003e\n\u003c/p\u003e\n\n## New New New ✨\nCheck out [serial.huhn.me](https://serial.huhn.me) for a web based serial monitor.  \nA great alternative that works with all Arduino projects and doesn't need to be installed. \nYou just need a compatible browser, like Chrome for desktop.\n\nBut no worries, it doesn't replace this project. Huhnitor remains to be our terminal based serial monitor!\n\n## Disclaimer\n\n**Please note** that while this software can be used for other serial devices and projects, it is designed to be used with the \n[ESP8266 Deauther Version 3](https://github.com/SpacehuhnTech/esp8266_deauther/tree/v3).  \n\n## Installation \n\n**Youtube Tutorial:**  \n[![Huhnitor Installation Video Tutorial](https://img.youtube.com/vi/tSH_wjFreHQ/0.jpg)](https://www.youtube.com/watch?v=tSH_wjFreHQ\u0026t=95s)\n\n### Using released binary (Recommended for Windows)\n\n1. Go to the [release page](https://github.com/SpacehuhnTech/Huhnitor/releases) and download a binary for your OS from the latest release.\n2. Run it by simply double clicking it or via terminal `./huhnitor` or `sudo ./huhnitor`  \n   **Linux \u0026 Mac** users will have to make the binary executable first by running `sudo chmod +x huhnitor`\n3. [Optional] Add it to the `PATH` variable for easy use in the terminal\n\n### Using Snap (Recommended for Linux)\n\n1. [Install snap](https://snapcraft.io/docs/installing-snapd) if it doesn't already come with your Linux distribution.\n2. Open a terminal and type  \n   `sudo snap install huhnitor --edge --devmode`  \n3. To start simply run `sudo huhnitor` in a terminal\n\nIf you get a `huhnitor not found` message, try adding snap to the PATH by running `export PATH=\"$PATH:/snap/bin\"`.  \n\n### Using AUR on Arch Linux\n\n1. Open a terminal and type  \n   `yay -S huhnitor`  \n2. To start simply run `sudo huhnitor` in a terminal\n\n### Using Homebrew (Recommended for macOS)\n\n1. Make sure [Homebrew](https://brew.sh/) is installed\n2. Open a terminal and type  \n   `brew tap spacehuhntech/huhnitor`  \n   `brew install huhnitor`  \n   or as a one-liner: `brew tap spacehuhntech/huhnitor \u0026\u0026 brew install huhnitor`\n3. To start simply run `huhnitor` in a terminal\n\n**Pro tip**: Homebrew can also be installed on Linux, and the Windows Subsystem for Linux.\n\n### Compiling it yourself\n\nPrecompiled binaries can be found at [releases](https://github.com/SpacehuhnTech/Huhnitor/releases).  \nBut if you want, you can compile the Huhnitor yourself:  \n\n1. Install Rust using [rustup](https://www.rust-lang.org/tools/install)  \n   **Linux users** will also need to run `sudo apt install libudev-dev pkg-config`  \n   **Windows users** have to install [Visual C++ Build Tools 2019](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019)  \n2. [Download and unzip](https://github.com/SpacehuhnTech/Huhnitor/archive/master.zip) or `git clone https://github.com/SpacehuhnTech/Huhnitor.git` this repository\n3. In the root directory of the repo run `cargo build --release`, your binary will be located in `target/release/` (you can use `cargo run` to start Huhnitor without compiling a binary)\n\n## Usage\n\nThe Huhnitor is designed to be as easy to use as possible:  \n\n1. Open huhnitor\n2. Plug in your deauther\n3. Have fun using the command line interface of the [ESP8266 Deauther](https://github.com/SpacehuhnTech/esp8266_deauther) :slightly_smiling_face:  \n\nIf the huhnitor has issues connecting to your deauther, try running it as administrator or via `sudo huhnitor`.  \nYou can also give a user permission to access the serial ports by running `sudo usermod -a -G dialout \u003cusername\u003e`.  \n\nThe Huhnitor can run scripts (a series of pre-written commands) if you enter `huhn read [filename]` once you are connected to a deauther. The file paths are relative to your current command line location (not the executable's) and are essentially a series of newline separated deauther commands.\n\nTo stop running a command on the deauther, you can hit ctrl + c, which is in theory more convenient and should help to prevent accidental disconnects. This does, however, also mean that you cannot exit the Huhnitor with ctrl + c, therefore once a serial connection has been opened, entering `exit` must be used to exit the Huhnitor.\n\n### Arguments\n\n| Argument                | Description                    |\n| ----------------------- | ------------------------------ |\n| `--help`       or `-h`  | print this help screen         |\n| `--port`       or `-p`  | enter port as argument         |\n| `--driver`     or `-d`  | open driver page               |\n| `--no-auto`    or `-a`  | disable automatic port connect |\n| `--no-color`   or `-c`  | disable colored output         |\n| `--no-welcome` or `-w`  | disable welcome message        |\n\n## Drivers\n\nYour deauther is not detected when plugged in?  \n**Make sure the USB connection is working. Some cables can only charge but not transmit data.**  \nDepending on the serial chip that is used on the ESP8266 development board you have, you might need to install the right driver:  \n\n* [CP210x](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)\n* [CH341](http://www.wch-ic.com/search?q=cH341\u0026t=downloads)\n* [FTDI](https://www.ftdichip.com/FTDrivers.htm)\n\nNot sure which one to install? A lot of ESP8266 based development boards use a chip from the CP210x family, try starting there.   \n\n## Credits\n\nMade with :heart: by [Jamz](https://github.com/the-Jamz) with help from [Selicre](https://selic.re)\u003cbr\u003e\nin cooperation with [Spacehuhn Technologies](https://github.com/SpacehuhnTech/)\n\n## License\n\nThis software is licensed under the MIT License. See the [license file](LICENSE) for details.  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspacehuhntech%2Fhuhnitor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspacehuhntech%2Fhuhnitor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspacehuhntech%2Fhuhnitor/lists"}