SS2K Overlay

[MarkusSchneider]

I've create an electron app to show smart spin 2k data during workout.
https://github.com/MarkusSchneider/SmartSpin2kOverlay
The data is collected via UDP (from the logs).

@doudar if you think this is interesting, you could add it to the https://github.com/SmartSpin2k repository and we can work together on the app.
We can also display any other data like Shifter step / Gear in simulation mode or what every we want to collect.

Any feedback is welcome.

Greetings
Markus

[doudar]

That's actually pretty cool!

Would there be a way to show connected devices and perhaps the power table as well?

How about future ability to change settings and other things from the ui?

[MarkusSchneider]

We can show there everything that we get out of the logs, also connected Devices and power table.
It should be possible to also change settings from the electron app. CORS could be a problem but could be solved.

Electron works on Windows, Linux and MacOS if you ran Zwift on Tablet it's not a good solution.

[doudar]

I run Zwift on Windows. Not sure what the userbase primarily uses, but at a minimum (SS2K Overlay) seems like a great and easy diagnostic tool.

I've never built anything with Electron, but I looked over the code and it seems to be all pretty easy Javascript, so that's very nice.

After doing some research on it today, would it be worthwhile (or feasible) to think about using Apache Cordova for this? I've never worked with it either, but it seems similar to Electron and if it did everything you need it to, it might allow a same code base native SS2K settings app for Windows, Mac, iOS and Android once we built out all the features. Edit: and maybe Cordova is getting outdated?

If Electron or Cordova supports BLE, we might have the ability to do some of this via the custom characteristic vv.

SmartSpin2k/src/BLE_Server.cpp

Lines 500 to 811 in fedebad

	/*
	Custom Characteristic for userConfig Variable manipulation via BLE
	An example follows to read/write 26.3kph to simulatedSpeed:
	simulatedSpeed is a float and first needs to be converted to int by *10 for transmission, so convert 26.3kph to 263 (multiply by 10)
	Decimal 263 == hexidecimal 0107 but the data needs to be converted to LSO, MSO to match the rest of the BLE spec so 263 == 0x07, 0x01 (LSO,MSO)
	So,
	If client wants to write (0x02) int value 263 (0x07 0x01) to simulatedSpeed(0x06):
	Client Writes:
	0x02, 0x06, 0x07, 0x01
	(operator, variable, LSO, MSO)
	Server will then indicate:
	0x80, 0x06, 0x07, 0x01
	(status, variable, LSO, MSO)
	Example to read (0x01) from simulatedSpeed (0x06)
	Client Writes:
	0x01, 0x06
	Server will then indicate:
	0x80, 0x06, 0x07, 0x01
	success, simulatedSpeed,0x07,0x01
	Pay special attention to the float values below. Since they have to be transmitted as an int, some are converted *100, others are converted *10.
	True values are >00. False are 00.
	*/
	void ss2kCustomCharacteristicCallbacks::onWrite(BLECharacteristic *pCharacteristic) {
	std::string rxValue = pCharacteristic->getValue();
	uint8_t read = 0x01; // value to request read operation
	uint8_t write = 0x02; // Value to request write operation
	uint8_t error = 0xff; // value server error/unable
	uint8_t success = 0x80; // value for success
	size_t returnLength = rxValue.length();
	uint8_t returnValue[returnLength];
	returnValue[0] = error;
	for (size_t i = 1; i < returnLength; i++) {
	returnValue[i] = rxValue[i];
	}
	SS2K_LOG(BLE_SERVER_LOG_TAG, "Custom Request Received");
	switch (rxValue[1]) {
	case BLE_firmwareUpdateURL: // 0x01
	returnValue[0] = error;
	break;
	case BLE_incline: { // 0x02
	returnValue[0] = success;
	if (rxValue[0] == read) {
	int inc = rtConfig.getTargetIncline() * 100;
	returnValue[2] = (uint8_t)(inc & 0xff);
	returnValue[3] = (uint8_t)(inc >> 8);
	returnLength += 2;
	}
	if (rxValue[0] == write) {
	rtConfig.setTargetIncline(bytes_to_u16(rxValue[3], rxValue[2]) / 100);
	}
	} break;
	case BLE_simulatedWatts: // 0x03
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(rtConfig.getSimulatedWatts().value & 0xff);
	returnValue[3] = (uint8_t)(rtConfig.getSimulatedWatts().value >> 8);
	returnLength += 2;
	}
	if (rxValue[0] == write) {
	rtConfig.setSimulatedWatts(bytes_to_u16(rxValue[3], rxValue[2]));
	}
	break;
	case BLE_simulatedHr: // 0x04
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(rtConfig.getSimulatedHr() & 0xff);
	returnValue[3] = (uint8_t)(rtConfig.getSimulatedHr() >> 8);
	returnLength += 2;
	}
	if (rxValue[0] == write) {
	rtConfig.setSimulatedHr(bytes_to_u16(rxValue[3], rxValue[2]));
	}
	break;
	case BLE_simulatedCad: // 0x05
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(rtConfig.getSimulatedCad() & 0xff);
	returnValue[3] = (uint8_t)(rtConfig.getSimulatedCad() >> 8);
	returnLength += 2;
	}
	if (rxValue[0] == write) {
	rtConfig.setSimulatedCad(bytes_to_u16(rxValue[3], rxValue[2]));
	}
	break;
	case BLE_simulatedSpeed: { // 0x06
	returnValue[0] = success;
	int spd = rtConfig.getSimulatedSpeed() * 10;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(spd & 0xff);
	returnValue[3] = (uint8_t)(spd >> 8);
	returnLength += 2;
	}
	if (rxValue[0] == write) {
	rtConfig.setSimulatedSpeed(bytes_to_u16(rxValue[3], rxValue[2]) / 10);
	}
	} break;
	case BLE_deviceName: // 0x07
	returnValue[0] = error;
	break;
	case BLE_shiftStep: // 0x08
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(userConfig.getShiftStep() & 0xff);
	returnValue[3] = (uint8_t)(userConfig.getShiftStep() >> 8);
	returnLength += 2;
	}
	if (rxValue[0] == write) {
	userConfig.setShiftStep(bytes_to_u16(rxValue[3], rxValue[2]));
	}
	break;
	case BLE_stepperPower: // 0x09
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(userConfig.getStepperPower() & 0xff);
	returnValue[3] = (uint8_t)(userConfig.getStepperPower() >> 8);
	returnLength += 2;
	}
	if (rxValue[0] == write) {
	userConfig.setStepperPower(bytes_to_u16(rxValue[3], rxValue[2]));
	updateStepperPower();
	}
	break;
	case BLE_stealthchop: // 0x0A
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(userConfig.getStealthchop());
	returnLength += 1;
	}
	if (rxValue[0] == write) {
	userConfig.setStealthChop(rxValue[2]);
	updateStealthchop();
	}
	break;
	case BLE_inclineMultiplier: { // 0x0B
	returnValue[0] = success;
	int inc = userConfig.getInclineMultiplier();
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(inc & 0xff);
	returnValue[3] = (uint8_t)(inc >> 8);
	returnLength += 2;
	}
	if (rxValue[0] == write) {
	userConfig.setInclineMultiplier(bytes_to_u16(rxValue[3], rxValue[2]));
	}
	} break;
	case BLE_powerCorrectionFactor: { // 0x0C
	returnValue[0] = success;
	int pcf = userConfig.getPowerCorrectionFactor() * 10;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(pcf & 0xff);
	returnValue[3] = (uint8_t)(pcf >> 8);
	returnLength += 2;
	}
	if (rxValue[0] == write) {
	userConfig.setPowerCorrectionFactor(bytes_to_u16(rxValue[3], rxValue[2]) / 10);
	}
	} break;
	case BLE_simulateHr: // 0x0D
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(rtConfig.getSimulateHr());
	returnLength += 1;
	}
	if (rxValue[0] == write) {
	rtConfig.setSimulateHr(rxValue[2]);
	}
	break;
	case BLE_simulateWatts: // 0x0E
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(rtConfig.getSimulateWatts());
	returnLength += 1;
	}
	if (rxValue[0] == write) {
	rtConfig.setSimulateWatts(rxValue[2]);
	}
	break;
	case BLE_simulateCad: // 0x0F
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(rtConfig.getSimulateCad());
	returnLength += 1;
	}
	if (rxValue[0] == write) {
	rtConfig.setSimulateCad(rxValue[2]);
	}
	break;
	case BLE_ERGMode: // 0x10
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(rtConfig.getERGMode());
	returnLength += 1;
	}
	if (rxValue[0] == write) {
	rtConfig.setERGMode(rxValue[2]);
	}
	break;
	case BLE_autoUpdate: // 0x11
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(userConfig.getautoUpdate());
	returnLength += 1;
	}
	if (rxValue[0] == write) {
	userConfig.setAutoUpdate(rxValue[2]);
	}
	break;
	case BLE_ssid: // 0x12
	returnValue[0] = error;
	break;
	case BLE_password: // 0x13
	returnValue[0] = error;
	break;
	case BLE_foundDevices: // 0x14
	returnValue[0] = error;
	break;
	case BLE_connectedPowerMeter: // 0x15
	returnValue[0] = error;
	break;
	case BLE_connectedHeartMonitor: // 0x16
	returnValue[0] = error;
	break;
	case BLE_shifterPosition: // 0x17
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(rtConfig.getShifterPosition() & 0xff);
	returnValue[3] = (uint8_t)(rtConfig.getShifterPosition() >> 8);
	returnLength += 2;
	}
	if (rxValue[0] == write) {
	rtConfig.setShifterPosition(bytes_to_u16(rxValue[3], rxValue[2]));
	}
	break;
	case BLE_saveToSpiffs: // 0x18
	userConfig.saveToSPIFFS();
	returnValue[0] = success;
	break;
	case BLE_targetPosition: // 0x19
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(ss2k.targetPosition & 0xff);
	returnValue[3] = (uint8_t)(ss2k.targetPosition >> 8);
	returnValue[4] = (uint8_t)(ss2k.targetPosition >> 16);
	returnValue[5] = (uint8_t)(ss2k.targetPosition >> 24);
	returnLength += 4;
	}
	if (rxValue[0] == write) {
	ss2k.targetPosition = (int32_t((uint8_t)(rxValue[2]) << 0 | (uint8_t)(rxValue[3]) << 8 | (uint8_t)(rxValue[4]) << 16 | (uint8_t)(rxValue[5]) << 24));
	}
	break;
	case BLE_externalControl: // 0x1A
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(ss2k.externalControl);
	returnLength += 1;
	}
	if (rxValue[0] == write) {
	ss2k.externalControl = static_cast<bool>(rxValue[2]);
	}
	break;
	case BLE_syncMode: // 0x1B
	returnValue[0] = success;
	if (rxValue[0] == read) {
	returnValue[2] = (uint8_t)(ss2k.syncMode);
	returnLength += 1;
	}
	if (rxValue[0] == write) {
	ss2k.syncMode = static_cast<bool>(rxValue[2]);
	}
	break;
	}
	pCharacteristic->setValue(returnValue, returnLength);
	pCharacteristic->indicate();
	}

[MarkusSchneider]

For the overlay I must be able to create a window on top of Zwift without border , menu, frames, ...
I also never worked with Cordova and don't know if this is possible.
State of the art is to create a progressiv web app to run your code native.
PWA is more limited in the interaction with the OS but its maybe not a huge problem.
I think I'll try this next.
I like the idea to have all important values on one screen 😁.

BEL could work with nobel and electron, for PWA I think its not implemented.

[doudar]

Yes, PWA Is probably the best way. I think they're all competing for the same space and it was hard for me to tell which has the most support and user base with limited research.

Will PWA allow the always on top window in windows Zwift that you like?

[doudar]

Possibly we could create a TCP socket on the SS2K as well. I'm not certain if that causes issues with the BLE and it would need to be tested.

[MarkusSchneider]

Not sure it a PWA would stay always on top. A PWA is more or less a web application running in the browser. But a simple workaround would be to open zwift and move the pwa-window over the zwift screen.
More important for me is the possibility to hide the title bar of the browser.

Yes TCP socket would maybe be the best solution or a web socket, but I saw the discussion to integrate AsyncWebServer an the problems 😒. A HTTP based communication would be nice because its supported well by browsers.

[doudar]

We could always try testing it (asynchronous web server) again . There's been a lot of changes in the last year. @h2zero , do you know if NimBLE and async are working well together nowadays?

[doudar]

Also, I was thinking you could use the existing http get method within the app to get the config data via JSON or make a new http handler that sends the JSON via debug output (udp).

[h2zero]

I haven't done any recent testing with async + BLE might be time to try it again.

[h2zero]

I think I have an answer: h2zero/NimBLE-Arduino#323 (comment)

[doudar]

I think I have an answer: h2zero/NimBLE-Arduino#323 (comment)

Dang! There it is again 😅