{"id":20730519,"url":"https://github.com/gbmhunter/serialfiller","last_synced_at":"2025-04-23T22:01:07.592Z","repository":{"id":69958684,"uuid":"94385065","full_name":"gbmhunter/SerialFiller","owner":"gbmhunter","description":"Like a serial killer, but friendlier. A C++ serial publish/subscribe based communication protocol.","archived":false,"fork":false,"pushed_at":"2018-01-30T21:59:06.000Z","size":116,"stargazers_count":37,"open_issues_count":3,"forks_count":6,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T03:51:12.074Z","etag":null,"topics":["cobs","communication","embedded","messaging","serial","uart"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gbmhunter.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","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":"2017-06-15T00:56:22.000Z","updated_at":"2025-02-16T01:49:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"bd95c89d-9686-42d3-a9c4-0be5709292ec","html_url":"https://github.com/gbmhunter/SerialFiller","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbmhunter%2FSerialFiller","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbmhunter%2FSerialFiller/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbmhunter%2FSerialFiller/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gbmhunter%2FSerialFiller/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gbmhunter","download_url":"https://codeload.github.com/gbmhunter/SerialFiller/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250522299,"owners_count":21444511,"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":["cobs","communication","embedded","messaging","serial","uart"],"created_at":"2024-11-17T05:11:50.656Z","updated_at":"2025-04-23T22:01:07.473Z","avatar_url":"https://github.com/gbmhunter.png","language":"C++","readme":".. role:: bash(code)\n    :language: bash\n\n.. role:: cpp(code)\n    :language: cpp\n\n============\nSerialFiller\n============\n\n--------------------------------------------------------------------------------------------------\nLike a serial killer, but friendlier. A C++ serial publish/subscribe based communication protocol.\n--------------------------------------------------------------------------------------------------\n\n.. image:: https://travis-ci.org/mbedded-ninja/SerialFiller.png?branch=master\n\t:target: https://travis-ci.org/mbedded-ninja/SerialFiller\n\n- Simple publish/subscribe system for sending messages across serial links\n- Ability to send any type of data on a \"topic\"\n- Optional packet acknowledge functionality with built in thread blocking (using C++11/14 features) on packet send until packet acknowledge is received.\n- Built-in thread safety (for performance reasons, thread safety can be disabled via :cpp:`SerialFiller::SetThreadSafetyEnabled(false)`)\n- COBS encoding for reliable, low-overhead framing of packets\n- CRC16 check for packet integrity (uses CRC16-CCITT, polynomial 0x1021, which does not suffer from the inability to detect :cpp:`0x00` bytes at the start of the packet)\n- Platform agnostic data I/O (you fill in the hardware abstraction layer by providing a callback for :cpp:`SerialFiller::txDataReady_` and call :cpp:`SerialFiller::GiveRxData()` when new RX data is available).\n- Functionality backed by numerous unit tests\n- CMake based build system\n- CLion project files provided (use of CLion is optional)\n\nExamples\n========\n\n**Setup:**\n\n.. code:: cpp\n\n    #include \u003cSerialFiller/SerialFiller.hpp\u003e\n\n\n    mn::SerialFiller serialFiller;\n\n\n**Publish example:**\n\n.. code:: cpp\n\n    // Publish the data { 0x01, 0x02, 0x03 } on topic \"mytopic\"\n    serialFiller.Publish(\"mytopic\", { 0x01, 0x02, 0x03 });\n\n**Subscribe example:**\n\n.. code:: cpp\n\n    // Provide a callback for \"mytopic\" messages using\n    // lambda notation.\n    serialFiller.Subscribe(\"mytopic\", [](std::vector\u003cuint8_t\u003e rxData) -\u003e void {\n        std::cout \u003c\u003c \"Received packet on mytopic!\" \u003c\u003c std::endl;\n        \n        std::cout \u003c\u003c \" Data = \";\n        for(auto dataByte : rxData) {\n            std::cout \u003c\u003c std::to_string(dataByte);\n        }\n        std::cout \u003c\u003c std::endl;\n    });\n\nSee the source code in the :bash:`examples` directory for more real-world examples!\n\nBuilding/Installing\n===================\n\nClone this repository. Then :bash:`cd` into the repo's root directory and do one of the following:\n\nUse The Script\n--------------\n\nTo build only:\n\n.. code:: bash\n\n    ~/SerialFiller$ ./tools/build.sh\n\nTo build AND install:\n\n.. code:: bash\n\n    ~/SerialFiller$ ./tools/build.sh -i\n\nManual\n------\n\n.. code:: bash\n\n    ~/SerialFiller$ mkdir build\n    ~/SerialFiller$ cd build\n    ~/SerialFiller/build$ cmake ..\n    ~/SerialFiller/build$ make\n\n\nOnce SerialFiller has been built, run:\n\n.. code:: bash\n\n    ~/SerialFiller/build$ sudo make install\n\nInstallation Info\n-----------------\n\nOn a typical Linux system, the above install commands will install the static library :bash:`libSerialFiller.a` into :bash:`/usr/local/bin` and the header files into :bash:`/usr/local/include/SerialFiller` (a directory is created inside :bash:`/usr/local/include` as not to pollute the system folder space).\n\nThis command does NOT install the unit tests or examples.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgbmhunter%2Fserialfiller","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgbmhunter%2Fserialfiller","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgbmhunter%2Fserialfiller/lists"}