ackack 0.1.0

No project description provided

(Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 License, Author Wonder Waffle https://www.deviantart.com/wonder-waffle/art/ACK-ACK-Mars-Attacks-359710975 )

Have fun with your vaccuum robot!

AckAck is a simple control API to manually controll weback vacuum robots. Paired with its web interface, and a RTPS (in my case, I’m using an old yi ants camera with yi-hack)

This way you can remotely-scare your cats!

Keys

Use your arrow keys to move the robot left, right, go front or turn backwards. Enter will start cleaning and backspace will stop.

Environment variables

You’ll need to setup your weback username and password. Usually, this will be your phone + the password you use on the control app. Besides that, only RTSP_URL is required.

KEY	Description
RTSP_URL	Yi camera’s RTSP stream URL
WEBACK_USERNAME	Your weback’s username (phone number)
WEBACK_PASSWORD	Your weback’s password
BASE_URL	Base URL, for reverse proxies

Installation

Docker

With docker, just setup the specified env vars and launch the image. You can use the following docker-compose.yml example. Setting base_url is useful in reverse proxy scenarios (like traefik).

version: "3.3"
services:
  ackack:
    image: XayOn/ackack
    restart: unless-stopped
    ports:
      - 8080:8080
    environment:
      RTSP_URL: http://192.168.1...
      WEBACK_USERNAME: [phone]
      WEBACK_PASSWORD: yourpassword
      BASE_URL: /ackack

Manual setup

Install the project, set your environment variables, launch ffmpeg to create a m3u8 file in static/playlist.m3u8 from your rtsp.

Requires ffmpeg. Check your distro’s instructions on how to install ffmpeg You can checkout docker-entrypoint.sh and use its ffmpeg command

pip install ackack
WEBACK_USERNAME="+34-XXXX" WEBACK_PASSWORD="XXXX" poetry run uvicorn ackack:app

How does it work?

Ackack is simply an API for movement commands on python’s weback unofficial library, with an interface in plain html + js (with just videojs, minimal), paired with an ffmpeg command that converts the rtsp output of the yi camera to a format playable by your browser.