{"id":21432270,"url":"https://github.com/ultimaker/libarcus","last_synced_at":"2025-04-13T02:23:54.222Z","repository":{"id":18495801,"uuid":"21691769","full_name":"Ultimaker/libArcus","owner":"Ultimaker","description":"Communication library between internal components for Ultimaker software","archived":false,"fork":false,"pushed_at":"2025-03-27T09:50:41.000Z","size":672,"stargazers_count":75,"open_issues_count":24,"forks_count":81,"subscribers_count":44,"default_branch":"main","last_synced_at":"2025-04-12T10:48:43.906Z","etag":null,"topics":["c-plus-plus","cura","curaengine","protobuf"],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ultimaker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-07-10T11:29:07.000Z","updated_at":"2025-03-27T09:50:45.000Z","dependencies_parsed_at":"2023-01-13T19:51:35.973Z","dependency_job_id":"52ae9467-cdf5-4ede-b432-036a32f2053e","html_url":"https://github.com/Ultimaker/libArcus","commit_stats":{"total_commits":631,"total_committers":42,"mean_commits":"15.023809523809524","dds":0.6893819334389857,"last_synced_commit":"f9965dfa54c0b372a889c80ba0b97c01423dc685"},"previous_names":[],"tags_count":62,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ultimaker%2FlibArcus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ultimaker%2FlibArcus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ultimaker%2FlibArcus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ultimaker%2FlibArcus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ultimaker","download_url":"https://codeload.github.com/Ultimaker/libArcus/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248655030,"owners_count":21140416,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c-plus-plus","cura","curaengine","protobuf"],"created_at":"2024-11-22T23:17:47.153Z","updated_at":"2025-04-13T02:23:54.188Z","avatar_url":"https://github.com/Ultimaker.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Arcus\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/Ultimaker/libArcus/actions/workflows/conan-package.yml\" alt=\"Conan Package\"\u003e\n        \u003cimg src=\"https://github.com/Ultimaker/libarcus/actions/workflows/conan-package.yml/badge.svg\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/Ultimaker/libArcus/issues\" alt=\"Open Issues\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/issues/ultimaker/libarcus\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/Ultimaker/libArcus/issues?q=is%3Aissue+is%3Aclosed\" alt=\"Closed Issues\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/issues-closed/ultimaker/libarcus?color=g\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/Ultimaker/libArcus/pulls\" alt=\"Pull Requests\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/issues-pr/ultimaker/libarcus\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/Ultimaker/libArcus/graphs/contributors\" alt=\"Contributors\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/contributors/ultimaker/libarcus\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/Ultimaker/libArcus\" alt=\"Repo Size\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/repo-size/ultimaker/libarcus?style=flat\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/Ultimaker/libArcus/blob/master/LICENSE\" alt=\"License\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/ultimaker/libarcus?style=flat\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nThis library contains C++ code for creating a socket in a thread and using this socket to send and receive messages\nbased on the Protocol Buffers library. It is designed to facilitate the communication between Cura and its backend and similar code.\n\n\u003cbr\u003e\n\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/Ultimaker/libArcus/badge)](https://api.securityscorecards.dev/projects/github.com/Ultimaker/libArcus)\n\n\u003cbr\u003e\n\n## License\n\n![License](https://img.shields.io/github/license/ultimaker/libarcus?style=flat)  \nArcus is released under terms of the AGPLv3 License. Terms of the license can be found in the LICENSE file. Or at\nhttp://www.gnu.org/licenses/agpl.html\n\n\u003e But in general it boils down to:  \n\u003e **You need to share the source of any Arcus modifications if you make an application with Arcus.**\n\n## System Requirements\n\n### Windows\n- Python 3.6 or higher\n- Ninja 1.10 or higher\n- VS2022 or higher\n- CMake 3.23 or higher\n- nmake\n- protobuf\n- zlib\n- Conan 1.56.0\n\n### MacOs\n- Python 3.6 or higher\n- Ninja 1.10 or higher\n- apply clang 11 or higher\n- CMake 3.23 or higher\n- make\n- protobuf\n- zlib\n- Conan 1.56.0\n\n### Linux\n- Python 3.6 or higher\n- Ninja 1.10 or higher\n- gcc 12 or higher\n- CMake 3.23 or higher\n- make\n- protobuf\n- zlib\n- Conan 1.56.0\n\n\n## How To Build\n\n\u003e **Note:**  \n\u003e We are currently in the process of switch our builds and pipelines to an approach which uses [Conan](https://conan.io/)\n\u003e and pip to manage our dependencies, which are stored on our JFrog Artifactory server and in the pypi.org.\n\u003e At the moment not everything is fully ported yet, so bare with us.\n\nIf you want to develop Cura with libArcus see the Cura Wiki: [Running Cura from source](https://github.com/Ultimaker/Cura/wiki/Running-Cura-from-Source)\n\nIf you have never used [Conan](https://conan.io/) read their [documentation](https://docs.conan.io/en/latest/index.html)\nwhich is quite extensive and well maintained. Conan is a Python program and can be installed using pip\n\n### 1. Configure Conan\n\n```bash\npip install conan==1.56\nconan config install https://github.com/ultimaker/conan-config.git\nconan profile new default --detect --force\n```\n\nCommunity developers would have to remove the Conan cura repository because it requires credentials. \n\nUltimaker developers need to request an account for our JFrog Artifactory server at IT\n```bash\nconan remote remove cura\n```\n\n### 2. Clone libArcus\n```bash\ngit clone https://github.com/Ultimaker/libArcus.git\ncd libArcus\n```\n\n### 3. Install \u0026 Build libArcus (Release OR Debug)\n\n#### Release\n```bash\nconan install . --build=missing --update\n# optional for a specific version: conan install . arcus/\u003cversion\u003e@\u003cuser\u003e/\u003cchannel\u003e --build=missing --update\ncmake --preset release\ncmake --build --preset release\n```\n\n#### Debug\n\n```bash\nconan install . --build=missing --update build_type=Debug\ncmake --preset debug\ncmake --build --preset debug\n```\n\n## Creating a new Arcus Conan package\n\nTo create a new Arcus Conan package such that it can be used in Cura and Uranium, run the following command:\n\n```shell\nconan create . arcus/\u003cversion\u003e@\u003cusername\u003e/\u003cchannel\u003e --build=missing --update\n```\n\nThis package will be stored in the local Conan cache (`~/.conan/data` or `C:\\Users\\username\\.conan\\data` ) and can be used in downstream\nprojects, such as Cura and Uranium by adding it as a requirement in the `conanfile.py` or in `conandata.yml`.\n\nNote: Make sure that the used `\u003cversion\u003e` is present in the conandata.yml in the libArcus root\n\nYou can also specify the override at the commandline, to use the newly created package, when you execute the `conan install`\ncommand in the root of the consuming project, with:\n\n\n```shell\nconan install . -build=missing --update --require-override=arcus/\u003cversion\u003e@\u003cusername\u003e/\u003cchannel\u003e\n```\n\n## Developing libArcus In Editable Mode\n\nYou can use your local development repository downsteam by adding it as an editable mode package.\nThis means you can test this in a consuming project without creating a new package for this project every time.\n\n```bash\n    conan editable add . arcus/\u003cversion\u003e@\u003cusername\u003e/\u003cchannel\u003e\n```\n\nThen in your downsteam projects (Cura) root directory override the package with your editable mode package.  \n\n```shell\nconan install . -build=missing --update --require-override=arcus/\u003cversion\u003e@\u003cusername\u003e/\u003cchannel\u003e\n```\n\n## Using the Socket\n\n\nThe socket assumes a very simple and strict wire protocol: one 32-bit integer with\na header, one 32-bit integer with the message size, one 32-bit integer with a type id\nthen a byte array containing the message as serialized by Protobuf. The receiving side\nchecks for these fields and will deserialize the message, after which it can be processed \nby the application.\n\nTo send or receive messages, the message first needs to be registered on both sides with \na call to `registerMessageType()`. You can also register all messages from a Protobuf \n .proto file with a call to `registerAllMessageTypes()`. For the Python bindings, this \nis the only supported way of registering since there are no Python classses for \nindividual message types.\n\nThe Python bindings expose the same API as the Public C++ API, except for the missing\n`registerMessageType()` and the individual messages. The Python bindings wrap the\nmessages in a class that exposes the message's properties as Python properties, and\ncan thus be set the same way you would set any other Python property. \n\nThe exception is repeated fields. Currently, only repeated messages are supported, which\ncan be created through the `addRepeatedMessage()` method. `repeatedMessageCount()` will\nreturn the number of repeated messages on an object and `getRepeatedMessage()` will get\na certain instance of a repeated message. See python/PythonMessage.h for more details.\n\nOrigin of the Name\n==================\n\nThe name Arcus is from the Roman god Arcus. This god is the roman equivalent of\nthe goddess Iris, who is the personification of the rainbow and the messenger\nof the gods.\n\nJava\n====\nThere is a Java port of libArcus, which can be found [here](https://github.com/Ocarthon/libArcus-Java).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fultimaker%2Flibarcus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fultimaker%2Flibarcus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fultimaker%2Flibarcus/lists"}