Read before you walk
Safety
Walka does not move your treadmill. It only listens to it: the belt is started, stopped and set to a speed by you, at the treadmill itself. You walk on it while you look at a game, and you do that at your own risk.
At your own risk
Walka does not move the belt, but you still walk on a treadmill while you play, and that is at your own risk. This page says what Walka does to a treadmill and what it cannot do, what has and has not been verified, what is yours to check before you walk, and when to ask a doctor first.
The long versions are in Walka's repository: docs/SAFETY.md for what Walka does to a treadmill and how that is made sure of, and DISCLAIMER.md for risk, health and no warranty. Please read the disclaimer before your first walk.
Walka only listens
Walka does not start, stop, pause or steer the belt. Not from the game, not from the dashboard, not when something goes wrong.
-
You start the belt with the treadmill's remote or buttons, and you stop it the same way - or with its safety key
Keep the remote where your hand finds it without looking.
-
The speed is the one you set at the treadmill
Walka reads it; it cannot change it. It sets no speed and limits none.
-
Closing Walka, or pressing Disconnect, ends the recording and lets go of the treadmill
The belt goes on doing what it was doing.
-
When you step off, stop the belt
Nothing else will.
Walka listens to what your treadmill reports - its speed, its distance, on some pads its steps - and writes your walks down. Starting the belt, stopping it and choosing its speed are yours, with the treadmill's own remote, buttons and safety key, exactly as if Walka were not there.
The dashboard - Walka's own page - says so on its Live view:
Walka only listens to your treadmill. It cannot start, stop or change the speed of the belt: you set the speed on the treadmill itself.
If you used an earlier Walka
Earlier versions were different: the belt followed your character, and the companion - the Walka program on your computer - started, stopped and steered it. That has been taken out, not switched off. A motorised belt under someone who is looking at a game was not worth the risk of a program getting it wrong. Those versions have been withdrawn; do not use one.
If you have a version older than 0.7.0: it could move the belt. Those downloads have been removed; replace it with the current one and delete the old Walka.exe. Your walks and settings are kept (the settings that were about steering the belt are simply no longer read), and the addon is updated with Install on the dashboard.
What went with the belt commands - the STOP button and its hotkey among them - is listed under How that is made sure of. None of it is there any more: you stop the belt at the treadmill.
What Walka does to a treadmill, all of it
Two words come up all the time. The companion is the program on your computer (Walka.exe, or Walka on a Mac) that listens to the treadmill, records your walks and shows the dashboard. The addon is the part of Walka in the game. More on how it works.
When the companion connects to a treadmill it reads one value, and switches notifications on for three things it listens to:
On the treadmill:What Walka does with it
- Supported Speed Range
- reads it, once - the treadmill's speed range, which the dashboard shows
- Treadmill Data
- listens: speed, distance, time, and steps where the pad sends them
- Fitness Machine Status
- listens: the pad saying that it was started, stopped, paused or set to another speed
- Training Status
- listens: its countdown
- Fitness Machine Control Point
- never written to and never listened to - the one channel through which an app can start, stop or steer a belt
That is everything. Switching a notification on is the only thing Walka ever writes to a treadmill, and it is what every app that shows a treadmill's numbers has to do. Walka does not ask the treadmill for control.
What Walka does not do on any treadmill: start it, stop it, change its speed or touch the incline. It has no speed limit of its own, because it sets no speed. So the treadmill does not have to be one that apps can control: one that apps can watch and not drive is all Walka needs.
How that is made sure of
Not by a setting, and not by a rule that could be got round. The parts that moved the belt are gone:
- There is no command to send. The code that builds treadmill commands (request control, start, stop, pause, set speed) has been deleted, with the rules that decided when to send them, the manual session, the STOP button and hotkey, and the second process that stopped the belt if the companion was killed.
- There is no way to send one. The companion reaches a treadmill through one small interface (
BleClientintreadmill/ftms_ble.py), which can connect, read a value and switch notifications on. It has no write. The treadmill reader built on it (Treadmillintreadmill/base.py) can connect and disconnect, and nothing else. - Nothing the game shows reaches the treadmill. The strip of squares that the addon draws in the corner of the game window says one thing the companion uses: which walking session of which character a walk is filed under. The old "belt speed wanted" field of the strip is always zero now, and a companion ignores it whatever an older addon puts there.
- Nothing the dashboard does reaches the treadmill either. Its buttons connect and disconnect the companion, change settings, install the addon and delete walks. Disconnect and closing the companion let go of the treadmill and leave the belt exactly as it is.
The automated tests check each of these: that the reader and the Bluetooth adapter have no method that could write; that no command builder exists; that an emulated treadmill which records every byte written to it has recorded none after long runs of everything the game, the dashboard and the radio can do; and that a belt does the same, tick for tick, whether or not a companion is listening to it and whatever the game shows meanwhile.
It is also the one rule for changes to Walka: the companion listens to the treadmill and never writes to it, and tests fail if a way to do so comes back. Those tests run against a simulated and an emulated treadmill, not a real one - see what has and has not been verified.
What the addon does
The addon in the game does not move anything either - it never could; it only ever drew the strip.
- Start on the HUD - the small Walka box in the game - or
/walka startmarks a walking session: "I am walking now, for this character". The companion files the walk it records under that session. - The numbers on the HUD are estimates, counted from the pace you tell the addon (
/walka pace, or the - and + buttons on the HUD): an addon cannot be told what the treadmill is really doing while the game runs. The pace only feeds the HUD's estimate; it changes nothing at the treadmill. What the treadmill measured replaces the estimates after the next/reloador login. - Pause and Stop on the HUD pause and end the session - the addon's count - and nothing else: stop the belt yourself, at the treadmill, when you step off.
- Going AFK pauses the session - that is, the addon's count - if you leave that option on. The belt is not touched by it: stop the belt yourself when you step off.
What has and has not been verified
This software has not yet been run against a physical treadmill by its author. What that leaves open is whether your walks are counted right - whether a particular treadmill is found, and whether its numbers are read as it means them. It does not leave open whether the belt can be moved: there is nothing in Walka that could.
That is the whole of the claim. You still walk on a treadmill while you play, at your own risk and with no warranty: see the disclaimer.
What has been checked
- Walka's logic is exercised by a large automated test-suite against a simulated treadmill and against an emulated one at the Bluetooth level, both modelled on the documented behaviour of UREVO firmware.
- The reader listens to the same standard characteristics as open-source projects that work with UREVO pads, including one that lists the Strol 2E (URTM030) as verified on hardware.
- The Mac version is built on GitHub's Macs, which run its tests and check that the finished program starts, records a walk on a simulated pad and saves it when it is closed.
Walka's own hardware notes call the evidence from those other projects moderate. For the Strol 2E itself there is one person's report and a community-reported list. Everything else comes from sibling models, which share a firmware family but are not the same pad.
What has not
- A real treadmill. None of the treadmills Walka names - UREVO, WELLFIT or any other - has been tried by its author on the real machine yet.
- The game itself. The addon was tested under a mock of the game client - never in the game itself.
- A real Mac. Nobody has yet tried the Mac version with the game and a walking pad on a real Mac.
- Walka's own window. GitHub's machines open it in every build and load the dashboard in it. It has not been looked at on a real PC yet, and nobody has clicked in it on a real Mac.
- Shutting Windows down. Saving the walk when Windows logs off or shuts down has not been tried on a real PC yet. A walk in progress is also saved every half minute, and picked up again at the next start.
- Some of what the Strol 2E does over Bluetooth. Still unknown for this pad: the exact speed range and step it advertises, where (or whether) it reports steps, how it reports what is done at the pad, and whether it switches itself off, and drops the connection, after a long pause.
Treadmills of other makes
A WELLFIT, or any other treadmill that sends standard treadmill data, is read in the same way - also one that cannot be driven by apps at all. But the simulated and the emulated treadmill are modelled on UREVO firmware. For a WELLFIT there is one owner's report, with another program; for other makes nothing is known first-hand.
That is what the checks are for. Run the probe - like Walka itself it only listens; it sends the treadmill no commands - and then compare the dashboard with the treadmill's own display. The steps are under Before your first walk.
Before you walk
Walka is not a medical device and nothing in it is medical advice. Its calories, steps and heart rate are estimates, for interest only.
- Ask a doctor first if you have a heart condition, high blood pressure, trouble with balance or dizziness, an injury, if you are pregnant, if you take medicine that affects your balance or your heart rate, if you have not exercised for a long time - or if you are in any doubt.
- Stop at once if you feel dizzy, faint, short of breath, have pain in your chest, or anything hurts. Stop the belt at the treadmill and step off.
- Follow your treadmill's own manual: its weight limit, its safety key or clip, the free space it asks for behind and beside the belt, the floor it stands on, what to wear on your feet.
- Adults only. Keep children and pets away from the treadmill, and stop the belt when you step off.
- Your eyes are on a game. Walking while you play takes more care than walking. Choose a slow speed, keep the treadmill's remote within reach, and do not do it when you are tired or have been drinking.
Before your first walk
The pad and the game have not been tested against this code. Nothing here can move the belt, so what there is to check is whether your walk is counted right:
Walka.exe probeOn a Mac it is typed in Terminal: drag the
Walkaapplication into a Terminal window (that types where it is), then - with no space in between - type/Contents/MacOS/Walka probeand press Return. How to type a command on Windows is under Walka's window.It lists what the pad exposes and listens while you operate it with the remote. It sends the treadmill no commands. Keep the report - it settles the open questions in the hardware notes.
Walk for a few minutes with the dashboard open
Compare it with the treadmill's own display: the speed, and after the walk the distance and the steps. If they disagree, please open an issue with the probe report.
Walka.exe beaconwith the game runningOn a Mac:
Walka beacon.Checks that the strip of squares the addon draws in the corner of the game window can be read from your screen.
In game
The checks in the in-game checklist.
And for you, not for Walka: start slow, and know where the remote is. You walk at your own risk, and Walka has not yet been tried on a real walking pad: read the disclaimer first.
When you do walk
- Start slow. Studies of treadmill desks find people settle at 1-2 mph, that typing is barely affected there, and that mouse work suffers most. Expect your aim to be worse than seated.
- Keep the remote where your hand finds it without looking, and use the safety key or clip if your treadmill has one.
- Choose a speed and leave it. Changing the speed in the middle of a fight is one more thing to do with a hand you need.
- Do the first sessions out of combat, somewhere quiet.
- Leave the pad's buzzer on. Its countdown is the warning that the belt is about to move, for you and for whoever else is in the room.
- Stop the belt when you step off. Walka will not do it for you - nothing will. Children and pets: a belt left running is a hazard.
What Walka is, and is not
- A notebook, not a remote control. Walka reads what your treadmill reports over Bluetooth - speed, distance, on some pads steps - and writes your walks down. It has no way to start or stop a belt or to change its speed, and it sends the treadmill no commands (how that is made sure of). Earlier versions did drive the belt. They have been withdrawn: do not use one.
- A free hobby project, and an early one. Its author has not yet run it against a physical treadmill (see what has and has not been verified).
- Not a safety device. Walka cannot stop a belt. The treadmill's own stop button, remote and safety key are what stops it - keep them within reach.
- Not a medical device, and not medical advice. Calories, steps, heart rate and everything worked out from them are estimates, for interest only. Do not use them to decide anything about your health, your diet, your medication or your training.
- Not made, tested or approved by the maker of your treadmill. Walka connects to the treadmill the way a fitness app does, to read its numbers. Most treadmills accept one such connection at a time, so the maker's own app cannot be connected while Walka is.
- Not approved by Blizzard. See Is this allowed?
Walka is a fan-made tool. It is not affiliated with or endorsed by Blizzard Entertainment, UREVO, WELLFIT or any other maker of treadmills. World of Warcraft is a trademark of Blizzard Entertainment, Inc.; the other names belong to their owners.
It is your decision
By downloading, installing or using Walka you accept that you do so at your own risk. Whether walking at a desk while playing is safe for you, for your treadmill and for the room you do it in is for you to decide - and so is whether to let anyone else do it on your equipment.
No warranty, and a limit of liability. In plain words: Walka is provided as is and as available, with no warranty of any kind, express or implied - not of safety, accuracy or fitness for a particular purpose, nor any other - and nothing in Walka, its documentation or its dashboard is a promise that it will work without fault or without interruption. To the fullest extent the law permits, its authors, contributors and copyright holders are not liable for any claim, damages or other liability arising from, out of or in connection with Walka or the use of it - in contract, in tort (including negligence) or otherwise - and that includes personal injury, death, damage to property or equipment, loss of data, and action taken against a game account. The law of some places does not allow all of this; nothing here takes away a right that the law says cannot be taken away, and where that is so, the above applies as far as the law allows.
That is a summary, and it changes nothing in the text itself. The full text is DISCLAIMER.md: please read it before your first walk.
The dashboard's Live view says the short of it whenever Walka is open: Walka only listens to your treadmill, and walking while you play is at your own risk. It points to the disclaimer.
Found a safety or security problem?
Walka only listens to a treadmill: it has no way to start or stop a belt or to change its speed. The worst thing that could be wrong with it is therefore that this is not true. If you have found a way to make Walka send a treadmill anything at all, or to get at what it stores, please say so in private first.
How to report. On GitHub, open the Security tab of Walka's repository and choose Report a vulnerability (direct link). Only the maintainer sees the report. Please do not open a public issue for it, and do not post the details anywhere else until there is a fix.
Say what you did, what happened, on which version (the dashboard's footer and Walka.exe --version show it) and on which system. A way to repeat it is worth more than anything else.
Walka is a hobby project with one maintainer: there is no bounty, and no promised time to answer. A report that concerns the belt is looked at before everything else. You will be told what was found and when a fixed version is out, and named in its notes if you want to be.
What counts.
- Walka writing to a treadmill. Any way - through the dashboard, the game's signal, a setting, a file, a crafted Bluetooth device - to make the companion send a treadmill a command, or write to any of its characteristics beyond switching on the notifications it listens to.
- Anything that lets someone or something other than the person at the computer read what Walka stores (walks, weight and height, heart rate), change its settings or delete walks - for example another web page open in the same browser, or another device on the network - or make Walka send anything anywhere.
- A picture or video on the screen that is taken for the game's signal. It can no longer move anything, but it could file a walk under the wrong character.
- Writing files outside Walka's own folders and the game's addon folder.
- Putting something into a release that is not built from the repository's code.
What does not. A program that already runs on the same computer, someone with physical access to the computer or the treadmill, other software on a treadmill's Bluetooth - a treadmill takes commands from whatever connects to it, and that is the treadmill's design, not Walka's - and antivirus programs that flag Walka.exe without naming anything. Ordinary bugs - a walk is not recorded, a number is wrong, a treadmill is not found - go to the issue tracker.
Only the latest release is fixed. Earlier versions could start, stop and steer a belt; they have been withdrawn and are not supported. If you still have one, replace it with the latest release. The whole policy is in SECURITY.md.
The long versions
- docs/SAFETY.md - what Walka does to a treadmill, how that is made sure of, and what has and has not been verified.
- DISCLAIMER.md - what Walka is and is not, before you walk, no warranty, limit of liability, names.
- docs/HARDWARE.md - what is known about the treadmills, where it comes from, and what still needs confirming.
- docs/IN-GAME-CHECKLIST.md - the checks to do in the game.
- SECURITY.md - reporting a security or safety problem.