Repository files navigation

This library contains C++ code for creating a socket in a thread and using this socket to send and receive messagesbased on the Protocol Buffers library. It is designed to facilitate the communication between Cura and its backend and similar code.

Arcus is released under terms of the AGPLv3 License. Terms of the license can be found in the LICENSE file. Or athttp://www.gnu.org/licenses/agpl.html

But in general it boils down to:
You need to share the source of any Arcus modifications if you make an application with Arcus.

• Python 3.6 or higher
• Ninja 1.10 or higher
• VS2022 or higher
• CMake 3.23 or higher
• nmake
• protobuf
• zlib
• Conan 1.56.0

• Python 3.6 or higher
• Ninja 1.10 or higher
• apply clang 11 or higher
• CMake 3.23 or higher
• make
• protobuf
• zlib
• Conan 1.56.0

• Python 3.6 or higher
• Ninja 1.10 or higher
• gcc 12 or higher
• CMake 3.23 or higher
• make
• protobuf
• zlib
• Conan 1.56.0

Note:
We are currently in the process of switch our builds and pipelines to an approach which usesConanand pip to manage our dependencies, which are stored on our JFrog Artifactory server and in the pypi.org.At the moment not everything is fully ported yet, so bare with us.

If you want to develop Cura with libArcus see the Cura Wiki:Running Cura from source

If you have never usedConan read theirdocumentationwhich is quite extensive and well maintained. Conan is a Python program and can be installed using pip

pip install conan==1.56conan config install https://github.com/ultimaker/conan-config.gitconan profile new default --detect --force

Community developers would have to remove the Conan cura repository because it requires credentials.

Ultimaker developers need to request an account for our JFrog Artifactory server at IT

conan remote remove cura

git clone https://github.com/Ultimaker/libArcus.gitcd libArcus

conan install. --build=missing --update# optional for a specific version: conan install . arcus/<version>@<user>/<channel> --build=missing --updatecmake --preset releasecmake --build --preset release

conan install. --build=missing --update build_type=Debugcmake --preset debugcmake --build --preset debug

To create a new Arcus Conan package such that it can be used in Cura and Uranium, run the following command:

conan create. arcus/<version>@<username>/<channel> --build=missing --update

This package will be stored in the local Conan cache (~/.conan/data orC:\Users\username\.conan\data ) and can be used in downstreamprojects, such as Cura and Uranium by adding it as a requirement in theconanfile.py or inconandata.yml.

Note: Make sure that the used<version> is present in the conandata.yml in the libArcus root

You can also specify the override at the commandline, to use the newly created package, when you execute theconan installcommand in the root of the consuming project, with:

conan install. -build=missing --update --require-override=arcus/<version>@<username>/<channel>

You can use your local development repository downsteam by adding it as an editable mode package.This means you can test this in a consuming project without creating a new package for this project every time.

    conan editable add. arcus/<version>@<username>/<channel>

Then in your downsteam projects (Cura) root directory override the package with your editable mode package.

conan install. -build=missing --update --require-override=arcus/<version>@<username>/<channel>

The socket assumes a very simple and strict wire protocol: one 32-bit integer witha header, one 32-bit integer with the message size, one 32-bit integer with a type idthen a byte array containing the message as serialized by Protobuf. The receiving sidechecks for these fields and will deserialize the message, after which it can be processedby the application.

To send or receive messages, the message first needs to be registered on both sides witha call toregisterMessageType(). You can also register all messages from a Protobuf.proto file with a call toregisterAllMessageTypes(). For the Python bindings, thisis the only supported way of registering since there are no Python classses forindividual message types.

The Python bindings expose the same API as the Public C++ API, except for the missingregisterMessageType() and the individual messages. The Python bindings wrap themessages in a class that exposes the message's properties as Python properties, andcan thus be set the same way you would set any other Python property.

The exception is repeated fields. Currently, only repeated messages are supported, whichcan be created through theaddRepeatedMessage() method.repeatedMessageCount() willreturn the number of repeated messages on an object andgetRepeatedMessage() will geta certain instance of a repeated message. See python/PythonMessage.h for more details.

The name Arcus is from the Roman god Arcus. This god is the roman equivalent ofthe goddess Iris, who is the personification of the rainbow and the messengerof the gods.

There is a Java port of libArcus, which can be foundhere.