Skip to main content

A code generator for remote procedure calls on embedded systems

Project description

Automated build

Code Smells

Quality gate

Code style: black

LotusRPC 🌼

WARNING: This project is work in progress

LotusRPC is an RPC framework for embedded systems based on ETL. It generates C++ code with no dynamic memory allocations, no exceptions, no RTTI, etc. Code generator and client side CLI application in a simple Python package.

Installation

Install from PyPI with pip install lotusrpc

Basic usage

Installing the Python package installs the lrpcg tool on your system. This is the LotusRPC generator. It also installs the lrpcc tool on your system. This is the LotusRpc CLI client.

Your RPC interface is specified in a YAML file

File name: example.lrpc.yaml

services:
  - name: "battery"
    functions:
      - name: "get"
        params:
          - name: "option"
            type: "@VoltageScales"
        returns:
          - name: "voltage"
            type: double
enums:
  - name: "VoltageScales"
    fields:
        name: "microvolts"
        name: "millivolts"
        name: "volts"

Generate server side code by simply running this command

lrpcg cpp -d example.lrpc.yaml -o output-dir

Give the generated code a meaningful implementation and hook it up to a transport layer. Flash your embedded device. Then use lrpcc to communicate with your device and print the result to the console

lrpcc battery get microvolts

Documentation

Please find more detailed information here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lotusrpc-0.9.3.tar.gz (784.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lotusrpc-0.9.3-py3-none-any.whl (45.1 kB view details)

Uploaded Python 3

File details

Details for the file lotusrpc-0.9.3.tar.gz.

File metadata

  • Download URL: lotusrpc-0.9.3.tar.gz
  • Upload date:
  • Size: 784.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for lotusrpc-0.9.3.tar.gz
Algorithm Hash digest
SHA256 3efb445cf4350ff67d0802cc2b75ce0961873d91441d0e55f30ebefa1da5fb0b
MD5 86407a67df05a4fd45d700282c90ba1d
BLAKE2b-256 bc0f53e3b04a77d688ec245e4fa135e7be93c75abb337619913e30d840d238be

See more details on using hashes here.

Provenance

The following attestation bundles were made for lotusrpc-0.9.3.tar.gz:

Publisher: publish-to-pypi.yml on tzijnge/LotusRpc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lotusrpc-0.9.3-py3-none-any.whl.

File metadata

  • Download URL: lotusrpc-0.9.3-py3-none-any.whl
  • Upload date:
  • Size: 45.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for lotusrpc-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3850a22a620c4c1f2bf14370650f2416b868ed328588f713ef3aac6994944a7a
MD5 fa92ed4cf2499f9f2daef720e02232d0
BLAKE2b-256 ab5fb533757b21de06acb1d733207dba34943410fbbce34ceafeb4ffd2433299

See more details on using hashes here.

Provenance

The following attestation bundles were made for lotusrpc-0.9.3-py3-none-any.whl:

Publisher: publish-to-pypi.yml on tzijnge/LotusRpc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page