https://github.com/stmicroelectronics/compost-rpc

RPC protocol generator. Abstracts communication between a PC and an MCU. Basically it allows you to call functions on your MCU from a PC.
https://github.com/stmicroelectronics/compost-rpc

Last synced: 6 months ago
JSON representation

RPC protocol generator. Abstracts communication between a PC and an MCU. Basically it allows you to call functions on your MCU from a PC.

• Host: GitHub
• URL: https://github.com/stmicroelectronics/compost-rpc
• Owner: STMicroelectronics
• License: bsd-3-clause
• Created: 2025-06-24T08:50:15.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-10-02T15:07:20.000Z (8 months ago)
• Last Synced: 2025-11-15T02:22:21.967Z (7 months ago)
• Language: Python
• Homepage:
• Size: 1.11 MB
• Stars: 11
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# Compost

Compost is a Remote Procedure Call ([RPC](https://en.wikipedia.org/wiki/Remote_procedure_call))

protocol generator with a simple wire format.

It abstracts communication between a PC and an MCU. Basically it allows you to

call functions on your MCU from a PC.

Compost is meant to be used over any medium, but it's simplicity is best suited

for UART/RS232 or UDP/IP.

## Install

    pip install compost_rpc

## Documentation

Documentation is available in the [Wiki](https://github.com/STMicroelectronics/compost-rpc/wiki)

## Introduction

With Compost you can write a function for your MCU in C, but call

it from Python or C# on a PC.

The call on the PC looks like a normal function

call, but Compost takes the arguments, creates a message and sends it

over a transport like serial port. Then, Compost on the MCU parses the message

and calls your function with the arguments you provided on the PC.

Your function returns a value. Compost on the MCU creates a response message

with the return value. The response is sent to PC. Compost on the PC parses the

message and the function you called on the PC returns the value you provided in

the MCU.

Simplified functionality diagram:

![Functional overview](docs/_static/image/getting_started/compost-simple.svg)

## Features

### Languge support

- C

  - C11 standard

  - Implemented roles

    - RPC server (callee)

    - Notification sender

    - Notification receiver

- Python

  - Needs version >= 3.10

  - Implemented roles

    - RPC client (caller)

    - Notification receiver

- C#

  - Implemented roles

    - RPC client (caller)

    - Notification receiver

### Transports

- UDP transport

- Serial transport

- Raw ethernet transport (Linux only)

- TCP transport

- Stdio transport

- Custom

### Data types

- 8, 16, 32 and 64-bit signed and unsigned integers

- 32 and 64-bit floating-point numbers (IEEE 754)

- Bit-precise integers

- C like Struct

- C like Enum with selectable underlying type

- Dynamically sized array (list) for each supported primitive type

## Try it!

You just need Python and a C compiler like GCC to run our single PC example.

Clone the repository and enter the directory with the example:

    git clone https://github.com/STMicroelectronics/compost-rpc.git

    cd compost-rpc/examples/pc_to_pc

Generate C code from the protocol definition:

    python protocol_def.py

Compile the server:

On Linux or macOS:

    gcc -o server main.c compost.c

On Windows:

    gcc -o server main.c compost.c -lws2_32

In one terminal run the C server:

    ./server

In another terminal run the Python client:

    python main.py

Client sends two integers and the server adds them together and sends the result back to the client.

It's probably the simplest Compost example you can have.

If you want to try Compost-RPC properly with an MCU, check out

the [Tutorial](https://github.com/STMicroelectronics/compost-rpc/wiki/Tutorial).