Skip to main content

A simple webpage that provides a digital pad and indicates who is at home.

Project description

FlatPad

FlatPad is a small tool that makes living with other people easier. See who is currently at home and share text on a digital pad.

Features

  • Know with a glance who is at home without checking for their shoes.
    • Works by checking your router for the MAC addresses of people's phones. (Currently only supports AVM Fritz!Box)
    • Falls back to using nmap if the router check fails.
  • Use the pad to share information.
    • Indicates whether the content is synced
    • Accessible to everyone in the network, no need for a messaging group.

Installation

pip3 install flatpad

Usage

flatpad run [port] (or ~/.local/bin/flatpad run if pip's binaries are not in your PATH). Now FlatPad is running at http://localhost:8000 or the port you specified.

Add the MAC addresses of the people you want to display on top of the page to the devices.json. It is located in FlatPad's directory: flatpad directory
(e.g. ~/.local/lib/python3.8/site-packages/flatpad/devices.json)

Simply follow the format of the default file. Names in the "People" segment will be green if at least one of their devices is in the network.
All MACs not listed in this section will be summed up and are shown in an extra bubble.
MACs in the "Ignored" section will not be counted towards this sum (e.g. your TV, a repeater or your toaster).

In order to use the Fritz!Box feature, specify its ip and the password in the config.ini in the same directory as above (without quotes).

For the nmap fallback, make sure that you have nmap installed on your system and it is able to open raw sockets without root access.
sudo setcap cap_net_raw+eip /usr/bin/nmap

Have fun!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flatpad-1.0.0.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flatpad-1.0.0-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file flatpad-1.0.0.tar.gz.

File metadata

  • Download URL: flatpad-1.0.0.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.9

File hashes

Hashes for flatpad-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9d53d80a84c2ab4ae4ee7dfba80bdf6cd096c01e35d5026cef4ba8103faf2531
MD5 1a98c077a8109ed2705d06d84bd3df04
BLAKE2b-256 12ac1cbcda3934d4afc79e11e197004185831c55c0e5a2b38dc16636b2ab0ddd

See more details on using hashes here.

File details

Details for the file flatpad-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: flatpad-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.9

File hashes

Hashes for flatpad-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 99ce46d03f3195a2184e42468d20ee28cbf365d4dcabf3018308fa57b6fe4b56
MD5 dc76cc13c4121b5c2f81b09f8f3cde7c
BLAKE2b-256 da5a4b305c81bb6f4c1b0c59b9a355ce562c0b6c933a51ef48492565ffe3b668

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page