pydsfapi [v3.2.0] - Official Python Client Library for DSF

wilriker

pydsfapi

Here is a first version of the official Python 3.5+ client library to DuetSoftwareFramework.

I covers all connections modes available with the C# client. Currently the Machine Model is implemented as a very simple class that holds all the values as dictionaries. This might change in the future once the object model is stable.

You can find it at GitHub.

Feedback

Please test it and report any issues you find here so it can be fixed/changed to get to a stable API as soon as possible.

Request to Python experts

This code has been ported with a less-than-optimal Python knowledge. I would kindly ask for Python experts to have a look where things can be made more Pythonic or implementations can be improved (I assume significant improvements can be done with the custom HTTP endpoint code in regards of starting and stopping the EventLoop).

gtj0

Great!! I'll start looking at it this afternoon from both a functional and Python perspective.

Danal

Fantastic! This was somewhere "on my list" and I'd much rather use an existing.

Great community here...

May I request a couple of usage examples in one of the readme.md files? I'd like to convert my tool alignment scripts ASAP.

wilriker

@Danal said in pydsfapi - Official Python Client Library for DSF [beta]:

Fantastic! This was somewhere "on my list" and I'd much rather use an existing.

Actually your existing library was a jump-start for me.

Great community here...

So thanks to you as well!

May I request a couple of usage examples in one of the readme.md files? I'd like to convert my tool alignment scripts ASAP.

I will add some. EDIT: This might take until tomorrow.

EDIT2: Just so you don't have to starve until then

# Initialize a new CommandConnection with debug mode enabled
command_connection = connections.CommandConnection(debug=True)
# Connect to default socket location
command_connection.connect()

try:
	# Run a command
	command_connection.perform_simple_code("M117 I'm alive", CodeChannel.SPI)
finally:
	# Close the connection
	command_connection.close()

gtj0

If @chrishamm doesn't show up soon, I think I'm just going to rewrite the entire DSF in python (or nodejs).

Danal

@gtj0 said in pydsfapi - Official Python Client Library for DSF [beta]:

If @chrishamm doesn't show up soon, I think I'm just going to rewrite the entire DSF in python (or nodejs).

I would actually vote for NodeJS, but either would be OK.

Danal

P.S. I did fix the M999 bug. Caveat Emptor and all that, this is my very first .net on Linux... etc, etc. If anyone is willing to try the 1.2.4.0 version of DuetControlServer with this fix, download this file:

http://danalspub.com/wp-content/uploads/2020/03/DuetControlServer.zip

Unzip, and place the two files inside in /opt/dsf/bin

The 'DuetControlServer' file should have attributes of -rwxr-xr-x. If for some reason it does not, run chmod 755 DuetControlServer

After the copies:
sudo systemctl stop duetcontrolserver
sudo systemctl start duetcontrolserver

If you decide to go back, run:

sudo apt-get reinstall duetcontrolserver

or

sudo apt-get reinstall duetcontrolserver=specific version number you wish

You can find all available versions via:
apt-cache policy duetcontrolserver

wilriker

@gtj0 said in pydsfapi - Official Python Client Library for DSF [beta]:

If @chrishamm doesn't show up soon, I think I'm just going to rewrite the entire DSF in python (or nodejs).

He's currently working on both DWC and DSF to get the ObjectModel up to date.

But either way please don't replace one interpreted language for another. On a RPi use something that runs natively. Use Go or Rust.

gtj0

@wilriker said in pydsfapi - Official Python Client Library for DSF [beta]:

@gtj0 said in pydsfapi - Official Python Client Library for DSF [beta]:

If @chrishamm doesn't show up soon, I think I'm just going to rewrite the entire DSF in python (or nodejs).

He's currently working on both DWC and DSF to get the ObjectModel up to date.

But either way please don't replace one interpreted language for another. On a RPi use something that runs natively. Use Go or Rust.

HA!. I hear COBOL is making a comeback. Actually the new "thing" is nim

wilriker

@Danal (and interested others):

I have pushed a change that has added an examples.py that shows minimal examples of the three (four) most common usage scenarios.

Also mind that I renamed the main entry point from a generic connections.py to a more specific pydsfapi.py.

Danal

Thank you! I will take a look, and target adapting this into my tool alignment scrips.

JBisc

@wilriker For beginners (of APIs) it would be very useful, so see an example in which you interact more with the duet (like move/ call M115 / read pin). I feel slighly overwhelmed with your example....

wilriker

@JBisc There is an update to pydsfapi coming in the next couple of days. I'll update the examples then also. Thanks for pointing it out.

wilriker

@JBisc I haven't changed much with the examples but added a lot of comments (see https://github.com/Duet3D/DSF-APIs/blob/dev/pydsfapi/examples.py). Is that already enough to get you started? If not can you please provide a detailed set of things you want to achieve and I'll be happy to either add this to the examples.py or reply to it here in the thread.

JBisc

@wilriker Thanks. I will try it directly tomorrow and give feedback to you. Just for others who are searching: these changes are still on the dev Branch.

JBisc

@wilriker Ok I tried. I took the latest commit on the dev branch (Hash: 7b7c9291aaa1e77bd570c2503f981a73410a0f32)

I changed:

cmd_conn.connect('/var/run/dsf/dcs.sock')

I ran the example file with python 3.7 and the RPI and sudo rights (dcs.sock requires it)

and I got the following error

File "/home/shares/pi/HandwritingRoboter/src/DSF-APIs/pydsfapi/pydsfapi.py", line 234, in connect
  server_init_message.EXPECTED_SERVER_VERSION, server_init_message.version))
AttributeError: 'ServerInitMessage' object has no attribute 'EXPECTED_SERVER_VERSION'

Probably you have an Idea what that could be?

wilriker

@JBisc Yeah, the reason was me refactoring a name right before committing but after testing.

But there is another problem why it would not have happened for me anyway: the version on the dev branch requires DSF 2.1.0 from unstable repo.

EDIT: I pushed another change fixing this bug right before I posted here. So once you upgraded to DSF 2.1.0 the latest commit on dev should work.

wilriker

Release 2.1.0

I present to you the first official release of pydsfapi which can be found at GitHub Releases page as usual.

This is the first release of pydsfapi and it is target at compatibility with Duet Software Framework 2.1.0 and later (it specifically does not work with DSF 1.2.4 and earlier).

With this release the package structure has been brought to a Python standard layout and a setup.py has been added for easier installation via disttools.

What's missing

There are no concrete class implementations representing the ObjectModel. For now there is a placeholder class MachineModel that has all the values as dict with dicts inside it.

wilriker

Release v2.1.2

This release can be found as usual on GitHub Releases page.

Port changes from upstream

Increase PROTOCOL_VERSION to 6
Add G53 to string output of commands that use it

wilriker

Release 3.1.0

This release syncs changes and version with latest DuetSoftwareFramework and can be found as usual on GitHub Releases page.

Ported changed from upstream

Increase PROTOCOL_VERSION to 7
Add new Aux2 CodeChannel
Comments now use Q as CodeType (instead of C)
Letter for unprecedented parameters has been changed from empty string to @