Make a python version of the remote control API that works over rs232

[davetcc]

As it says on the tin, a Python API that will connect to and remotely control the menu library, just like it's Java counterpart

[davetcc]

Issues to be thought about, how to deal with the connection loops that are threads in Java. What test application should be used etc..

[davetcc]

If any python user of the library wants to have a go at implementing the protocol for python, I'd be very glad to help you understand the protocol and help out with Serial and Socket understanding..

[vzahradnik]

I will need to build a library for Dart (because of Flutter) and some time later also for Python (because I will most likely build a Home Assistant integration). So perhaps I could work on both.

Is the remote control API identical when using RS232 vs TagValue? I will need TagValue support but ideally I could support both.

[davetcc]

That would be great, I would provide as much help as I possibly could with that as it would be generally useful to many, there are four API implementations at the moment that you can look at:

• Typescript (Javascript): https://github.com/davetcc/embedcontrolJS
• Java: TcMenuJavaAPI in this project.
• C++: In the tcMenuLib repo
• .NET: I even have an experimental C# version that was never released as isn't really complete.

All of the implementations use the same protocol and messaging, ethernet, RS232 and even the websocket version is just a thin websocket wrapper around the same protocol. It is best to assume that other protocols could be added later, and only process messages that have protocol 1 (TagVal). Probably the best starting point is: https://www.thecoderscorner.com/products/apps/embed-control/embed-control-tagval-wire-protocol/ and then take a look through the current implementations.

I'd recommend maybe starting with some unit tests and a protocol converter in one of the languages that can serialize the messages. If you create a repo for it, or if you prefer to put it here I'll do my best to help out with it as well.

[vzahradnik]

I think the easiest approach will be if I create the repos and later I will transfer ownership to you. From the start, there will be a lot of commits and I don't want to waste anyone's time on approving the work-in-progress code.

Allright, I will start by looking at the existing code and we can discuss in this thread. Later, if it will be necessary, we can also chat through some other clients.

Thanks!

[davetcc]

How is it going on the library front, feel free to add me on any repo you create, I've done a few different ports of the API now, and I could probably help get something workable quite quickly. You can ping me using the contact form on thecoderscorner or PM me in the forum.

[vzahradnik]

Hi @davetcc I had busy month working on non-coding stuff. I have this in my mind and will definitely ask you when I hit on some block.

[vzahradnik]

@davetcc what do you use for testing besides writing unit tests for the parser? I will need to test realtime communication between the library and the embedded server. Ideally I would use something like an embedded simulator on my local PC if there's anything like that.

[davetcc]

For the embedded simulator I just use a menu generated from tcMenu for Raspberry Pi/Java and add Ethernet support. Runs fine on most desktops.

There is even one ready built with instructions for running it in this repo see the embedded Java example. Just needs a JDK with JavaFX. I tend to use Liberica JDK.

[davetcc]

Let me know if you have trouble building it and I’ll jpackage it to somewhere for now.

[davetcc]

It struck me recently that if all you want is a UI for iOS and Android, another starting point may be embedCONTROL.js

With a React.native front end, you could target both mobile devices very easily and the API is pretty much already written and working, at least for WebSockets. A full socket and Bluetooth implementation could follow for the native version.

There is already a web front end working that works well with mobile, If you run the embeddedJavaExample in the tcMenu project the web UI is served from port 8080, if native bindings were used instead of webpage bindings it may do most of what you need.

https://github.com/davetcc/embedcontrolJS

[vzahradnik]

Hi Dave,

I came to a similar idea to you. Just instead of embedCONTROL.js I would use Flutter. There is a library to embed JS code.
Anyway, I still think native versions would be better. Eventually, I will most likely need Python library too.

I already started my work on the app, except it is not bound to actual data. Now I start in paralell working on the library. My guess is that it won't be that complex once I get the gist of it.

https://www.youtube.com/watch?v=T_nFXBiCyZ4

By the way, does this protocol support embedding custom data/messages? Because I'd like to send additional information, like status messages. I have a status screen and I want users to know just by looking at the display what is the state of the device.

Thanks!