iot-maneki-neko

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

iot-maneki-neko

★ 8 Open GitHub ↗

🐱 IoT Maneki-Neko (Beckoning Cat, Luck Cat, Winkekatze)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# IoT Maneki-Neko

---

## Public Archive Notice

This repository has been transitioned to a public archive.
While development has ceased, the codebase remains available for reference and historical purposes.

**Impact on Current Users:**

* New features and bug fixes will no longer be implemented.
* Issues and pull requests will not be reviewed or merged.

**Accessing the Codebase:**

* You can continue to clone, fork, and explore the code at your convenience.
* The codebase reflects the repository's state at the time of archiving.

**Staying Informed:**

* I recommend considering alternative projects that are actively maintained for your ongoing development needs.

**Contributing:**

* While new contributions are no longer accepted in this repository, feel free to explore forking the codebase and creating your own derivative project.

**Thank You:**

I appreciate your past contributions and interest in this project.
I hope the archived codebase remains a valuable resource!

---

With `iot-maneki-neko.ino` and an **ESP8266** (like the NodeMCU Lua Lolin V3 Module) you can make a Maneki-Neko (Beckoning Cat, Luck Cat, Winkekatze) to an IoT Maneki-Neko.
Let's make a thing to an thing with internet or internet of things.
Inspired by the Chaos Communication Camp Project [Winkekatze](https://events.ccc.de/camp/2015/wiki/Projects:Winkekatze).

![IoT Maneki-Neko](https://raw.githubusercontent.com/Cyclenerd/iot-maneki-neko/master/img/iot-cat.jpg)

## Set-Up

You need an ESP8266 and a Maneki-Neko.
Open `iot-maneki-neko.ino` with the Arduino IDE and adjust the configuration:

* `cat_name` : Your cat name
* `ssid`     : Your WiFi SSID
* `password` : Your WiFi password

Upload `iot-maneki-neko.ino` to your ESP8266.

Connect `D0` and `D1` each with one LED.

![Pins](https://raw.githubusercontent.com/Cyclenerd/iot-maneki-neko/master/img/pins.jpg)

Connect `D2` to the motor (magnet).

![Motor](https://raw.githubusercontent.com/Cyclenerd/iot-maneki-neko/master/img/motor.jpg)

## Remote Control

Open `index.html` with your favorite text editor and adjust the configuration:

* `cat_name` : Your cat name

Open `index.html` with your favorite web browser and control your IoT Maneki-Neko.

With the Perl script `wave.pl` you can also control your cat. 
With `mqtt-subscribe.pl` you can see all commands of all IoT cats.

## How does it work?

* The ESP8266 connects itself via WiFi and gets by DHCP an IP address.
* The computer connects to the MQTT broker `iot.eclipse.org`.
	* MQTT is explained in [Wikipedia](https://en.wikipedia.org/wiki/MQTT).
* The MQTT topic `winkekatze/YOUR-CAT-NAME/command` is subscribed.
* When the text `wave` appears, the cat starts to wave.

## Help 👍

If you have found a bug (English is not my mother tongue) or have any improvements, send me a pull request.

iot-maneki-neko

Today's picks

Was this content helpful?

Recent Feedback

iot-maneki-neko

Today's picks

Was this content helpful?

Recent Feedback

Download README