ShockAlarm

 

A powerful app for controlling OpenShock shockers and setting alarms with custom tones.

A web version (for IOS, ...) can be found here (does not support live controls).

Features

ShockAlarm is a powerful tool for controlling your Shockers via OpenShock. It allows you to fully manage your shockers, logs, shares, hubs, share links, tokens and sessions. On top it also allows you to seamlessly use ShareLinks.

There is advanced functionality like controlling multiple shockers at the same time, specifying a random interval for intensity, duration and a delay, live controls with patterns and alarms.

It's fully material you themed just like the standard Android apps you're already used to and provides a responsive ui with a nice design.

Furthermore it fixes some layout flaws of the official OpenShock Frontend like having shared and own shockers in separate tabs (which is annoying). On top it also has lots of info buttons you can press to get more insight on what something does.

You can also log in on multiple OpenShock instances at once. ShockAlarm will show all shockers from all instances seamlessly at a glance!

Other information

I cannot guarentee that all features work with all possible configurations. I try to make them work with each other but sometimes I miss them. For example a random intensity won't work with the shock confirmation dialog. However a hard limit will.

Not supported in Web Version

Everything with websockets is currently not supported due to authentication problems with websockets. This includes:

• OTA Updates
• Enabling/Disabling the captive portal
• Live control

Installation on Android

Through Obtainium (recommended as you get the updates the fastest)

1. Download Obtainium either via their website or FDroid
2. Add ShockAlarm by clicking here or putting codeberg.org/Kaiya/ShockAlarmApp as th app source

FDroid

1. Download FDroid
2. Search for ShockAlarm and install it. As easy as that!

GitHub

Install the apk file from the releases

Installation on Linux

Through the AUR

Use your favorite aur helper like paru or yay and install shock-alarm. link to aur

Installation on Windows

Installer

You can download a Windows installer from the releases and then execute it.

Portable

You can download a Portable version (zip file) from the releases, unzip and then execute it.

Screenshots

More images

Planned features

• (Un)Pausing of shockers
• Login with username/email and password
• Random delay
• Renaming of shockers (global)
• Viewing of logs
• Change sharing limits
• Create share codes
• Redeem share codes
• Adding of shockers
• Creation, editing and pairing of hubs
• Add option to repeat default shock/vibration... option for one minute (perhaps adjustable in settings). Needs reworking of the alarm stop feature
• Websocket controlling
• Alarm tones
• Grouping of shockers
• Redo settings
• Random intensity and duration
• Safety warning
• Share link management
• Allow setting initial limits when adding a shocker
• Add ui to rename tones
• Better desktop support (keybinds)
• Better desktop support (layout)
• Better desktop support (dynamic layout)
• Show 3 point menu when 1 shocker is selected
• Share codes sometimes can't be claimed when the app is already open (treating as fixed for now)
• Show loading animation when share codes are loading in after shares loaded
• Allow toggling of the captive portal
• Add alarm renaming
• Finally code weekday scheduling for alarms
• Add changing of shocker type (and even hub and rfId)
• save last opened tab (and load it on start)
• Random shocking (specify random delay between shocks, min and max intensity/duration)
• Random shocking -> Add background task + notification (works without notification???)
• Fix alarms not sending controls when app is minimized (seems to work)
• Live controls
• Allow alarm tones to be used as patterns
• Request permissions only when needed
• fix reloading problems in settings after login?
• (Big controls mode) fuck this shit, there's no space
• Improved login for web (aka using token requests)
• Web support (alarms working via AlarmServer)
• Linux support (alarms working via AlarmServer)
• Alarm support for Linux and web via https://dev1.rui2015.me
• Add separate slider for shock and vibrate intensity
• Add Alarm tone support for AlarmServer
• Add info about alarm server
• Code cleanup, add multiple predefined dialogs
• Add online indicator for hubs on web
• Add OTA Updates
• Add Share Link support
• Fix WS on web
• Add Patterns to live controls
• Flaschendrehen
• Add shock confirmation above adustable intensity and duration.
• Adapt to new Backend duration limit
• Add confirmation on live system as well.
• Add global limit for self.
• Stop live playback when changing type
• Make sure text in popups is scrollable so it can be read completely
• Implement login V2 (All except linux)
• Implement Shares V2 (once officially declared done in backend and implementation in official frontend exists. Can't make sense of the api rn without explenation)

Planned settings

• Hide/unhiding of the delay option
• Slider instead of RangeSlider for delay

Development

This app is based on flutter and thus you need to first install flutter: https://docs.flutter.dev/get-started/install

Afterwards clone the repository and get all dependencies:

1. git clone https://codeberg.org/Kaiya/ShockAlarmApp
2. cd ShockAlarmApp
3. flutter pub get

Publishing

Steps for making a new release

1. Test functionality of app on Android, Web and Linux.
2. (when adding new packages) Test the Android build pipeline by manually triggering
3. Bump the version in pubspec.yaml and main.dart
4. Create a changelog at fastlane/metadata/android/en-US/changelogs in a file names <versioncode>.txt. It should be markdown formatted.
5. Create a new tag (or release) and push it to the repo. Actions will spin up to compile the binaries and add the previously created changelog to the release
6. (optional) Update the screenshots in fastlane/metadata/android/en-US/images/phoneScreenshots/ for FDroid and the ReadMe

Setting up a Windows vm for actions

1. Install git, nodejs, iscc
2. Install Vistual Studio build tools with Desktop for c++ (workflow; PS: this is pain af. I hate it!!!!!!!)
3. Install forgejo runner https://github.com/Crown0815/Forgejo-runner-windows-builder and register it (host runner).
4. Start the windows build via actions

Publishing on FDroid

FDroid will publish the update autonomously once a build cycle starts. The changelog we created earlier will be added to the FDroid page automatically