Skip to content
This repository has been archived by the owner on Sep 6, 2024. It is now read-only.

Latest commit

 

History

History
287 lines (196 loc) · 9.05 KB

README.md

File metadata and controls

287 lines (196 loc) · 9.05 KB

surplus on wheels

This project has been merged into the main project, surplus.

surplus on wheels (s+ow) is a pure shell script to get your location using termux-location, process it through surplus, and send it to messaging service or wherever using bridges.

surplus was made to emulate sending your location through the iOS Shortcuts app, and surplus on wheels complements it by running surplus automatically using a cron job.
(but using it manually also works!)

installing

Important

s+ow is a Termux-first script, and will not work anywhere else unless you have a utility that emulates termux-location on $PATH alongside bridges that supports your platform.

there are two notable ways to install s+ow:

  1. as a standalone script
  2. or, as a cron job.

there is also an installation script for quickly getting started from a fresh termux installation.

as a standalone script

  1. firstly install python and termux-api if you haven't already:

    pkg install python termux-api

    also install the accompanying the Termux:API app from F-Froid.

  2. install pipx

    pip install pipx

  3. install surplus:

    pip install https://github.com/markjoshwel/surplus/releases/latest/download/surplus-latest-py3-none-any.whl

  4. install surplus on wheels:

    mkdir -p ~/.local/bin/
curl https://raw.githubusercontent.com/markjoshwel/surplus-on-wheels/main/s+ow > ~/.local/bin/s+ow
chmod +x ~/.local/bin/s+ow

if ~/.local/bin is not in your $PATH, add the following to your shell's rc file:

export PATH="$HOME/.local/bin:$PATH"

et voilà! s+ow is now setup. to actually send the message to a messaging platform, install an appropriate bridge.

as a cron job

Important

these instructions rely on following the previous instructions.

  1. install necessary packages to run cron jobs:

    pkg install cronie termux-services

  2. restart termux and start the cron service:

    sv-enable cron

  3. set up the cron job:

    [!IMPORTANT]
    minimally fill in the SPOW_TARGETS variable before running s+ow.
    (see usage for more info)

    run the following command:

    crontab -e

    and add the following text:

    59 * * * *      bash -l -c "SPOW_TARGETS="" SPOW_CRON=y s+ow"

    this will run s+ow every hour, a minute before the hour.

    modify the variables as per your needs. see usage for more information.

et voilà! s+ow will now send a message every hour. feel free to experiment with the cron job to your liking. see crontab.guru if you’re new to cron jobs.

if you haven’t already, install an appropriate bridge to actually send a message to a messaging platform.

using installation scripts

Warning

these scripts assume you're starting from a fresh base installation of Termux. if you have already cron jobs, then manually carry out the instructiions in as a cron job.

Important

if not installed already, install Termux:API from F-Droid.

  1. setup s+ow:

    curl https://raw.githubusercontent.com/markjoshwel/surplus-on-wheels/main/termux-s+ow-setup | sh

  2. restart termux!

  3. setup cron job:

    curl https://raw.githubusercontent.com/markjoshwel/surplus-on-wheels/main/termux-s+ow-setup-cron | sh

    the script will run crontab -e, and you can then edit the variables as per your needs. minimally fill in the SPOW_TARGETS variable before running s+ow.
    see usage for more information.

et voilà! s+ow is now setup. to actually send the message to a messaging platform, install an appropriate bridge.

usage

environment variables

s+ow uses three environment variables, two of which are optional:

  1. SPOW_TARGETS
    a single line of comma-deliminated chat IDs with bridge prefixes.

    wa:[email protected],tg:-0000000000000000000,...

    in the example above, the WhatsApp chat ID is wa:-prefixed as recognised by the spow-whatsapp-bridge, and the Telegram chat ID is tg:-prefixed as recognised by the spow-telegram-bridge.

  2. SPOW_CRON (optional)
    set as non-empty to declare that s+ow is being run as a cron job.
    if running as a cron job, start s+ow one minute earlier than intended to account for the time it takes to run termux-location and surplus.
    s+ow will delay itself appropriately.

    setting it to n will also be treated as empty.

  3. LOCATION_PRIORITISE_NETWORK (optional)
    set as non-empty to declare that s+ow can just use network location instead of GPS if GPS is taking too long.
    you should only turn this on if punctuality means that much to you, or you’re in a country with cell towers close by or everywhere, like Singapore.

    setting it to n will also be treated as empty.

the JIDs can be obtained by sending a message to the user/group, while running s+ow mdtest, and examining the output for your message. JIDs are email address-like strings.

  1. LOCATION_TIMEOUT (optional)
    set as a number to override the default first location timeout of 50.

faking locations

sometimes you gotta do what you gotta do

you can fake your s+ow messages by either:

  1. setting a dummy last file in s+ow cache

    $HOME/.cache/s+ow/last is used as the fallback response when a part of s+ow (either termux-location or surplus errors out). you can set this file to whatever you want and just turn off location on your device.

  2. setting a fake file in s+ow cache

    [!WARNING]
    s+ow uses the read command to read the file. as such, it is possible for s+ow to prematurely stop reading the file if the file does not contain a trailing newline.

    you can also write text to $HOME/.cache/s+ow/fake to fake upcoming messages. the file is delimited by empty lines. as such, arrange the file like so:

    The Clementi Mall
3155 Commonwealth Avenue West
Westpeak Terrace
129588
Southwest, Singapore

Westgate
3 Gateway Drive
Jurong East
608532
Southwest, Singapore

...

    on every run of s+ow, the first group of lines will be consumed, and the file will be updated with the remaining lines. if the file is empty, it will be deleted.

bridges

there are two “official” bridges for s+ow:

bridges can be located anywhere, as long as they are reachable by the shell s+ow is running in.

s+ow will run the bridges through definitions in in $HOME/.s+ow-bridges. each line of $HOME/.s+ow-bridges is evaluated as a shell command, and is piped SPOW_TARGETS.

Warning

s+ow uses the read command to read the file. as such, it is possible for s+ow to prematurely stop reading the file if the file does not contain a trailing newline.

bring your own bridge

custom bridges are relatively easy as they are:

  1. an executable or script

  2. that reads SPOW_TARGETS (see usage) from stdin

    • bridges should account for the possibility of comma and space (, instead of just ,) delimited targets, and strip each target of preceding and trailing whitespace.

    • bridges should recognise a platform based on a prefix
      (e.g. wa: for WhatsApp, tg: for Telegram, etc.)

    • bridges do not need to account for the possibility of multiple lines sent to stdin.

  3. reads SPOW_MESSAGE (~/.cache/spow/message) for the message content

notes:

  1. stderr and stdout are redirected to s+ow’s error and output logs respectively.
  2. any errors encountered by the bridge should always result in a non-zero return.
    error logs will show the exact error code, so feel free to use other numbers than 1.
  3. persistent data such as credentials and session data storage are to be handled by the bridge itself.
    consider storing them in $HOME/.local/share/<bridge-name>/, or similar.

licence

surplus on wheels is free and unencumbered software released into the public domain. for more information, please refer to UNLICENCE or http://unlicense.org/.