can-api-generator 2.4.0__tar.gz → 2.6.0__tar.gz

{can_api_generator-2.4.0 → can_api_generator-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: can-api-generator
-Version: 2.4.0
+Version: 2.6.0
 Summary: Program to generate a 'signal' style CAN API in C
 Project-URL: Documentation, https://sr.ht/~laplace/can-api-generator#readme
 Project-URL: Issues, https://sr.ht/~laplace/can-api-generator/issues
@@ -20,6 +20,7 @@ Requires-Dist: can-db-model>=0.1
 Requires-Dist: cantools
 Requires-Dist: click
 Requires-Dist: jinja2
+Requires-Dist: pyyaml
 Requires-Dist: rich
 Description-Content-Type: text/markdown
 
@@ -56,6 +57,7 @@ Description-Content-Type: text/markdown
   - [`api`](#api)
   - [`cbdb`](#cbdb)
   - [`dyndec`](#dyndec)
+  - [Config file](#config-file)
 
 ## Installation
 
@@ -242,6 +244,31 @@ slot (`now % period == offset`); the missed slot is skipped, not caught up.
 The `tx_callback` rules are unchanged: in callback-only mode a `NULL` return queues nothing, and `send_now` stays set as well. Works with and without
 `--tx-signal-store`.
 
+#### Delta timing (`--tx-timing delta`)
+By default `<api>_periodic_tx` takes an absolute time and fires a message only when `now % period == offset`, so it has to be called on every tick. With
+`--tx-timing delta` it instead takes the number of ticks elapsed since the previous call, and each message counts down on its own:
+```c
+void <api>_periodic_tx_init(struct <Prefix>TxSignals *tx_signals);
+uint16_t <api>_periodic_tx(struct <Prefix>TxSignals *tx_signals, CanFrame *output_frame, uint32_t dt);
+
+uint32_t dt = now - prev;
+prev = now;
+while (<api>_periodic_tx(&tx_signals, &frame, dt)) {
+    send(&frame);
+    dt = 0;  // drain the other messages that fell due
+}
+```
+Every message whose countdown runs out during `dt` is marked pending; one pending frame is returned per call, in message order, and the rest are drained by calling
+again with `dt = 0`. With `--tx-function` there is no draining: one call hands every pending message to the sink, and a frame the sink rejects stays pending and is
+retried on the next call (unlike absolute timing, where the slot is missed).
+If `dt` spans several periods (a stall), the message is sent once and rescheduled to the next slot on its original grid, so its phase does not change. A message
+whose countdown runs out while `enable` is 0 is skipped, but its countdown keeps running. In callback-only mode a `NULL` callback return sends nothing for that slot.
+`send_now` behaves as with absolute timing; if it coincides with a due slot, a single frame is sent.
+
+In `MsgTxContext`, `last_tx` is replaced by `remaining` (ticks until the next slot) and `pending`. `<api>_periodic_tx_init` takes no time argument, and
+`<api>_update_tx_period(ctx, period)` re-phases the message to `offset + 1` ticks from the next call.
+`--time-as-tx-callback-arg` cannot be combined with delta timing, as there is no absolute time to pass.
+
 ### Encode All Signals
 Some messages use multiplexes combining many signals in to a single message. This may be particularly true for configuration messages that have many related parameters and use
 multiplexes to fit all parameters in to a single message using many mux groups. If the entire config should be read out and the read back happens periodically, the supervisory controller
@@ -610,6 +637,7 @@ to a mux group. The message list is followed immediately by that message's signa
 ## Command-line reference
 
 All generation is done through subcommands of `can-api-gen`. Run `can-api-gen COMMAND --help` for the authoritative option list.
+Every command also accepts `--config FILE`; see [Config file](#config-file).
 
 ### `api`
 
@@ -663,6 +691,8 @@ Options:
   `<api>_periodic_tx(tx_signals, now)` then queues every due message through it in one pass and returns the number accepted. A 0 return leaves `last_tx` and
   `send_now` untouched so the message is retried. See [Queueing frames through a bound TX function](#queueing-frames-through-a-bound-tx-function). Only meaningful
   together with `-p`.
+* `--tx-timing [absolute|delta]` — `absolute` (default) passes the current time to `<api>_periodic_tx`; `delta` passes the ticks since the previous call. See
+  [Delta timing](#delta-timing---tx-timing-delta). Only meaningful together with `-p`; cannot be combined with `--time-as-tx-callback-arg`.
 * `--rx-signal-store` — generate the permanent per-message RX signal store (the pre-2.0 default). Without it, global RX is callback-only: no store is
   generated and decoded signals reach the application only through the RX callback. See [Global RX](#global-rx). Only meaningful together with `-r`.
 * `--with-rx-valid` — in callback-only mode, add a `valid` field to `MsgRxContext` and set it on each matched frame, for struct-layout compatibility with
@@ -679,6 +709,8 @@ Options:
   to an existing project's frame struct naming.
 * `-lm`, `--length-member-name TEXT` — override the name of the `CanFrame` length member (default `length`).
 * `-pm`, `--payload-member-name TEXT` — override the name of the `CanFrame` payload member (default `payload`).
+* `--seed INT` — seed the random number generator that picks each periodic message's `offset_seed`, so repeated runs produce identical output.
+  Unseeded by default, so every run picks new values.
 * `-v`, `--verbose` — dump the processed message dicts that get fed into the Jinja templates. Useful when debugging template or generator changes.
 * `--help` — show the CLI help and exit.
 
@@ -715,3 +747,27 @@ Options:
 * `-lm`, `--length-member-name TEXT` — override the name of the `CanFrame` length member (default `length`).
 * `-pm`, `--payload-member-name TEXT` — override the name of the `CanFrame` payload member (default `payload`).
 * `--help` — show the CLI help and exit.
+
+### Config file
+
+Instead of repeating a long flag list, put the options in a YAML file and pass it with `--config FILE` to any command. The file has one section per command, so
+one file can serve `api`, `cbdb` and `dyndec`; a command reads only its own section. Keys are the long option names without the leading `--` or the
+positional argument names (dashes or underscores both work), and values are the option values (`true`/`false` for flags). A relative `db-file` is resolved
+against the config file's directory; output files are still written to the working directory.
+
+```yaml
+api:
+  db-file: db.kcd
+  library-name: my_api
+  node-name: DUT
+  periodic-tx: true
+  tx-signal-store: true
+  time-as-tx-callback-arg: true
+  id-member-name: can_id
+dyndec:
+  id-member-name: can_id
+```
+
+Anything given on the command line overrides the file. Every flag has a `--no-` form for this, e.g.
+`can-api-gen api --config can.yaml --no-tx-signal-store`. Positional arguments given on the command line fill from the left and take precedence over the
+file, so `can-api-gen api --config can.yaml other.kcd other_api DUT` ignores all three from the file. An unknown key or an invalid value is an error.

{can_api_generator-2.4.0 → can_api_generator-2.6.0}/README.md

@@ -31,6 +31,7 @@
   - [`api`](#api)
   - [`cbdb`](#cbdb)
   - [`dyndec`](#dyndec)
+  - [Config file](#config-file)
 
 ## Installation
 
@@ -217,6 +218,31 @@ slot (`now % period == offset`); the missed slot is skipped, not caught up.
 The `tx_callback` rules are unchanged: in callback-only mode a `NULL` return queues nothing, and `send_now` stays set as well. Works with and without
 `--tx-signal-store`.
 
+#### Delta timing (`--tx-timing delta`)
+By default `<api>_periodic_tx` takes an absolute time and fires a message only when `now % period == offset`, so it has to be called on every tick. With
+`--tx-timing delta` it instead takes the number of ticks elapsed since the previous call, and each message counts down on its own:
+```c
+void <api>_periodic_tx_init(struct <Prefix>TxSignals *tx_signals);
+uint16_t <api>_periodic_tx(struct <Prefix>TxSignals *tx_signals, CanFrame *output_frame, uint32_t dt);
+
+uint32_t dt = now - prev;
+prev = now;
+while (<api>_periodic_tx(&tx_signals, &frame, dt)) {
+    send(&frame);
+    dt = 0;  // drain the other messages that fell due
+}
+```
+Every message whose countdown runs out during `dt` is marked pending; one pending frame is returned per call, in message order, and the rest are drained by calling
+again with `dt = 0`. With `--tx-function` there is no draining: one call hands every pending message to the sink, and a frame the sink rejects stays pending and is
+retried on the next call (unlike absolute timing, where the slot is missed).
+If `dt` spans several periods (a stall), the message is sent once and rescheduled to the next slot on its original grid, so its phase does not change. A message
+whose countdown runs out while `enable` is 0 is skipped, but its countdown keeps running. In callback-only mode a `NULL` callback return sends nothing for that slot.
+`send_now` behaves as with absolute timing; if it coincides with a due slot, a single frame is sent.
+
+In `MsgTxContext`, `last_tx` is replaced by `remaining` (ticks until the next slot) and `pending`. `<api>_periodic_tx_init` takes no time argument, and
+`<api>_update_tx_period(ctx, period)` re-phases the message to `offset + 1` ticks from the next call.
+`--time-as-tx-callback-arg` cannot be combined with delta timing, as there is no absolute time to pass.
+
 ### Encode All Signals
 Some messages use multiplexes combining many signals in to a single message. This may be particularly true for configuration messages that have many related parameters and use
 multiplexes to fit all parameters in to a single message using many mux groups. If the entire config should be read out and the read back happens periodically, the supervisory controller
@@ -585,6 +611,7 @@ to a mux group. The message list is followed immediately by that message's signa
 ## Command-line reference
 
 All generation is done through subcommands of `can-api-gen`. Run `can-api-gen COMMAND --help` for the authoritative option list.
+Every command also accepts `--config FILE`; see [Config file](#config-file).
 
 ### `api`
 
@@ -638,6 +665,8 @@ Options:
   `<api>_periodic_tx(tx_signals, now)` then queues every due message through it in one pass and returns the number accepted. A 0 return leaves `last_tx` and
   `send_now` untouched so the message is retried. See [Queueing frames through a bound TX function](#queueing-frames-through-a-bound-tx-function). Only meaningful
   together with `-p`.
+* `--tx-timing [absolute|delta]` — `absolute` (default) passes the current time to `<api>_periodic_tx`; `delta` passes the ticks since the previous call. See
+  [Delta timing](#delta-timing---tx-timing-delta). Only meaningful together with `-p`; cannot be combined with `--time-as-tx-callback-arg`.
 * `--rx-signal-store` — generate the permanent per-message RX signal store (the pre-2.0 default). Without it, global RX is callback-only: no store is
   generated and decoded signals reach the application only through the RX callback. See [Global RX](#global-rx). Only meaningful together with `-r`.
 * `--with-rx-valid` — in callback-only mode, add a `valid` field to `MsgRxContext` and set it on each matched frame, for struct-layout compatibility with
@@ -654,6 +683,8 @@ Options:
   to an existing project's frame struct naming.
 * `-lm`, `--length-member-name TEXT` — override the name of the `CanFrame` length member (default `length`).
 * `-pm`, `--payload-member-name TEXT` — override the name of the `CanFrame` payload member (default `payload`).
+* `--seed INT` — seed the random number generator that picks each periodic message's `offset_seed`, so repeated runs produce identical output.
+  Unseeded by default, so every run picks new values.
 * `-v`, `--verbose` — dump the processed message dicts that get fed into the Jinja templates. Useful when debugging template or generator changes.
 * `--help` — show the CLI help and exit.
 
@@ -690,3 +721,27 @@ Options:
 * `-lm`, `--length-member-name TEXT` — override the name of the `CanFrame` length member (default `length`).
 * `-pm`, `--payload-member-name TEXT` — override the name of the `CanFrame` payload member (default `payload`).
 * `--help` — show the CLI help and exit.
+
+### Config file
+
+Instead of repeating a long flag list, put the options in a YAML file and pass it with `--config FILE` to any command. The file has one section per command, so
+one file can serve `api`, `cbdb` and `dyndec`; a command reads only its own section. Keys are the long option names without the leading `--` or the
+positional argument names (dashes or underscores both work), and values are the option values (`true`/`false` for flags). A relative `db-file` is resolved
+against the config file's directory; output files are still written to the working directory.
+
+```yaml
+api:
+  db-file: db.kcd
+  library-name: my_api
+  node-name: DUT
+  periodic-tx: true
+  tx-signal-store: true
+  time-as-tx-callback-arg: true
+  id-member-name: can_id
+dyndec:
+  id-member-name: can_id
+```
+
+Anything given on the command line overrides the file. Every flag has a `--no-` form for this, e.g.
+`can-api-gen api --config can.yaml --no-tx-signal-store`. Positional arguments given on the command line fill from the left and take precedence over the
+file, so `can-api-gen api --config can.yaml other.kcd other_api DUT` ignores all three from the file. An unknown key or an invalid value is an error.

{can_api_generator-2.4.0 → can_api_generator-2.6.0}/pyproject.toml

@@ -28,6 +28,7 @@ dependencies = [
   'jinja2',
   'click',
   'rich',
+  'pyyaml',
 ]
 
 [project.urls]

{can_api_generator-2.4.0 → can_api_generator-2.6.0}/src/can_api_generator/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2025-present Alexande Becker <nabla.becker@mailbox.org>
 #
 # SPDX-License-Identifier: LGPL-3.0-only
-__version__ = "2.4.0"
+__version__ = "2.6.0"

{can_api_generator-2.4.0 → can_api_generator-2.6.0}/src/can_api_generator/code_generator.py

@@ -52,6 +52,7 @@ def generate_api_implementation(msgs: list[dict],
                                 tx_function: bool = False,
                                 time_as_rx_callback_arg: bool = False,
                                 time_as_tx_callback_arg: bool = False,
+                                tx_timing: str = "absolute",
                                 ):
     header_template = jinja_env.get_template("header_template.jinja")
     source_template = jinja_env.get_template("source_template.jinja")
@@ -94,6 +95,7 @@ def generate_api_implementation(msgs: list[dict],
         tx_function=tx_function,
         time_as_rx_callback_arg=time_as_rx_callback_arg,
         time_as_tx_callback_arg=time_as_tx_callback_arg,
+        tx_timing=tx_timing,
     )
     source_code = source_template.render(
         messages=msgs,
@@ -123,6 +125,7 @@ def generate_api_implementation(msgs: list[dict],
         tx_function=tx_function,
         time_as_rx_callback_arg=time_as_rx_callback_arg,
         time_as_tx_callback_arg=time_as_tx_callback_arg,
+        tx_timing=tx_timing,
     )
     canframe_header_code = canframe_template.render(
         arb_id_member_name=arb_id_member_name,

{can_api_generator-2.4.0 → can_api_generator-2.6.0}/src/can_api_generator/main.py

@@ -1,6 +1,7 @@
 from can_api_generator.types import SignalDirection
 from importlib.metadata import files
 import hashlib
+import random
 import json
 import click
 import rich
@@ -12,6 +13,55 @@ from can_api_generator.cbdb_generator import generate_cbdb, build_sidecar, CbdbG
 from can_api_generator.utils import converrt_to_c_identifier
 from jinja2 import Environment, FileSystemLoader
 from pathlib import Path
+import yaml
+
+
+def _load_config(ctx, param, value):
+    """Turn the command's section of a YAML config file into click defaults.
+
+    The file maps command names to option tables, e.g. {"api": {"periodic-tx":
+    true}}. Keys are long option names or positional argument names (dashes
+    or underscores). The values become ctx.default_map, so everything given on
+    the command line still takes precedence over the file. Relative file
+    arguments are resolved against the config file's directory.
+    """
+    if value is None:
+        return
+    try:
+        with open(value) as config_file:
+            data = yaml.safe_load(config_file)
+    except (OSError, yaml.YAMLError) as e:
+        raise click.BadParameter(f"cannot read config file: {e}", ctx, param)
+    if data is None:
+        data = {}
+    if not isinstance(data, dict):
+        raise click.BadParameter(
+            "the config file must map command names to option tables", ctx, param)
+    section = data.get(ctx.info_name) or {}
+    if not isinstance(section, dict):
+        raise click.BadParameter(
+            f"section '{ctx.info_name}' must map option names to values", ctx, param)
+    known = {p.name: p for p in ctx.command.params if p.name != "config"}
+    defaults = {}
+    for key, option_value in section.items():
+        name = str(key).replace("-", "_")
+        if name not in known:
+            raise click.BadParameter(
+                f"unknown option '{key}' in section '{ctx.info_name}'", ctx, param)
+        if (isinstance(known[name], click.Argument)
+                and isinstance(known[name].type, click.Path)
+                and isinstance(option_value, str)):
+            option_value = str(Path(value).parent / option_value)
+        defaults[name] = option_value
+    ctx.default_map = {**(ctx.default_map or {}), **defaults}
+
+
+config_option = click.option(
+    "--config", type=click.Path(exists=True, dir_okay=False),
+    is_eager=True, expose_value=False, callback=_load_config,
+    help="YAML file providing defaults for this command's options and "
+         "arguments, under a section named after the command (api, cbdb, "
+         "dyndec). Anything given on the command line overrides the file.")
 
 
 @click.group()
@@ -23,13 +73,14 @@ def main():
 
 
 @main.command()
+@config_option
 @click.argument("DB_File", type=click.Path(exists=True, dir_okay=False),
                 required=True, nargs=1)
 @click.argument("Library_Name", type=str, required=True)
 @click.argument("Node_Name", type=str, required=True)
-@click.option("-f", "--force", is_flag=True, required=False, default=False,
+@click.option("-f", "--force/--no-force", required=False, default=False,
               help="Overwrite existing output files")
-@click.option("-a", "--encode-all-signals-func", is_flag=True, default=False,
+@click.option("-a", "--encode-all-signals-func/--no-encode-all-signals-func", default=False,
               help="Generate a function for each message that encodes every signal into frames at least once,"
                    " this is helpful when some signals are inside of a mux, but all signals need to be sent "
                    " regardless of how many frames need to be encoded to send the state of each signal at least"
@@ -50,74 +101,74 @@ def main():
 @click.option("-pm", "--payload-member-name", type=str, default="payload",
               help="The name of the CanFrame struct member that holds the "
                    "payload as uint64")
-@click.option("-r", "--global-rx", is_flag=True, default=False,
+@click.option("-r", "--global-rx/--no-global-rx", default=False,
               help="Generate a function and api-wide struct that updates an"
                    " api message struct upon reception of a matching frame")
-@click.option("-p", "--periodic-tx", is_flag=True, default=False,
+@click.option("-p", "--periodic-tx/--no-periodic-tx", default=False,
               help="Generate code that will define a TX struct as well as a function "
               "that periodically sends the messages according to their "
               "periodicity")
-@click.option("--ti-compatible", is_flag=True, default=False,
+@click.option("--ti-compatible/--no-ti-compatible", default=False,
               help="Generate C code that can be compiled using the TI C2000 compiler"
                    " The TI compiler does not handle variable declarations inside of case"
                    " blocks so the variable declaration is moved to the top of a switch")
-@click.option("--send-now", is_flag=True, default=False,
+@click.option("--send-now/--no-send-now", default=False,
               help="Add mechanism in to the periodic tx function that allows to immediately "
                    "send a message even if it is not enabled or has just been sent."
                    " This is useful for updating critical signals as early as possible after a change")
-@click.option("--double-buffered", is_flag=True, default=False,
+@click.option("--double-buffered/--no-double-buffered", default=False,
               help="Generate double-buffered signal storage so that an ISR can safely decode"
                    " RX frames without exposing a partially-decoded struct to readers, and so"
                    " that user code can stage TX signal updates without racing the periodic TX"
                    " encoder. Swaps are performed via per-message pointer swaps; an explicit"
                    " <api>_<msg>_commit call is required to publish staged TX values.")
-@click.option("--rx-callback-context", is_flag=True, default=False,
+@click.option("--rx-callback-context/--no-rx-callback-context", default=False,
               help="Add a void *rx_callback_context field to MsgRxContext and "
                    "pass it as the sole argument to the RX callback, widening "
                    "its signature to void (*rx_callback)(void *).")
-@click.option("--tx-callback-context", is_flag=True, default=False,
+@click.option("--tx-callback-context/--no-tx-callback-context", default=False,
               help="Add a void *tx_callback_context field to MsgTxContext and "
                    "pass it as the sole argument to the TX callback, widening "
                    "its signature to void (*tx_callback)(void *).")
-@click.option("--msg-as-rx-callback-arg", is_flag=True, default=False,
+@click.option("--msg-as-rx-callback-arg/--no-msg-as-rx-callback-arg", default=False,
               help="Pass a void * to the message's just-decoded signal struct "
                    "as the first argument to the RX callback. Composes with "
                    "--rx-callback-context, which appends the context pointer as "
                    "a second argument. Only meaningful together with -r.")
-@click.option("--rx-signal-store", is_flag=True, default=False,
+@click.option("--rx-signal-store/--no-rx-signal-store", default=False,
               help="Generate a permanent per-message RX signal store in the "
                    "global RX struct (the default before v2.0). Without it, "
                    "global RX is callback-only: decoded signals reach the "
                    "application solely through the per-message RX callback and "
                    "are never stored. Only meaningful together with -r.")
-@click.option("--with-rx-valid", is_flag=True, default=False,
+@click.option("--with-rx-valid/--no-with-rx-valid", default=False,
               help="In callback-only mode (no --rx-signal-store), add a valid "
                    "field to MsgRxContext and set it on each matched frame, for "
                    "struct-layout compatibility with store-based APIs. No effect "
                    "when --rx-signal-store is set.")
-@click.option("--msg-as-tx-callback-arg", is_flag=True, default=False,
+@click.option("--msg-as-tx-callback-arg/--no-msg-as-tx-callback-arg", default=False,
               help="Pass a void * to the message's store struct (the one about "
                    "to be encoded) as the first argument to the TX callback. "
                    "Composes with --tx-callback-context, which appends the "
                    "context pointer as a second argument. Only meaningful "
                    "together with -p.")
-@click.option("--tx-signal-store", is_flag=True, default=False,
+@click.option("--tx-signal-store/--no-tx-signal-store", default=False,
               help="Generate a permanent per-message TX signal store in the "
                    "periodic-TX struct (the default before v2.0). Without it, "
                    "periodic TX is callback-only: each scheduled message's "
                    "callback returns the struct to encode, and a NULL return or "
                    "missing callback sends nothing. Only meaningful with -p.")
-@click.option("--time-as-rx-callback-arg", is_flag=True, default=False,
+@click.option("--time-as-rx-callback-arg/--no-time-as-rx-callback-arg", default=False,
               help="Pass the current time (the now argument of "
                    "<api>_process_received_frame) to the RX callback as a "
                    "uint64_t, after the message pointer and before the context "
                    "pointer. Only meaningful together with -r.")
-@click.option("--time-as-tx-callback-arg", is_flag=True, default=False,
+@click.option("--time-as-tx-callback-arg/--no-time-as-tx-callback-arg", default=False,
               help="Pass the current time (the now argument of "
                    "<api>_periodic_tx) to the TX callback as a uint64_t, after "
                    "the message pointer and before the context pointer. Only "
                    "meaningful together with -p.")
-@click.option("--tx-function", is_flag=True, default=False,
+@click.option("--tx-function/--no-tx-function", default=False,
               help="Bind a frame sink to the periodic-TX API instead of "
                    "returning one frame per call. <api>_periodic_tx_init takes "
                    "a uint16_t (*tx_function)(void *, const <frame> *) and its "
@@ -125,18 +176,30 @@ def main():
                    "due message to it in a single pass and returns the number "
                    "accepted. A 0 return leaves last_tx and send_now untouched, "
                    "so the message is retried. Only meaningful with -p.")
-@click.option("--prefix-signal-struct-names", is_flag=True, default=False,
+@click.option("--tx-timing", type=click.Choice(["absolute", "delta"]),
+              default="absolute", show_default=True,
+              help="Timing argument of the periodic tx function. 'absolute' takes "
+                   "the current time and sends a message when it hits its "
+                   "period/offset slot. 'delta' takes the ticks elapsed since the "
+                   "previous call and counts each message down; without "
+                   "--tx-function the messages that are due are sent one per call "
+                   "and drained by further calls with dt=0. Only meaningful with -p.")
+@click.option("--prefix-signal-struct-names/--no-prefix-signal-struct-names", default=False,
               help="Prefix every per-message signal struct type name with the "
                    "CamelCase API prefix (the same prefix used for "
                    "<Prefix>RxSignals / <Prefix>TxSignals), so two similar APIs "
                    "(e.g. two versions of a database) can coexist in one "
                    "translation unit with distinct struct names.")
-@click.option("--prefix-context-struct-names", is_flag=True, default=False,
+@click.option("--prefix-context-struct-names/--no-prefix-context-struct-names", default=False,
               help="Prefix the MsgRxContext / MsgTxContext struct type names (and "
                    "their include-guard tokens) with the CamelCase API prefix, so "
                    "context structs from two coexisting APIs do not share one "
                    "definition.")
-@click.option("-v", "--verbose", is_flag=True, default=False,
+@click.option("--seed", type=int, default=None,
+              help="Seed for the random number generator that picks each "
+                   "message's offset_seed, so repeated runs produce identical "
+                   "output. Unseeded by default.")
+@click.option("-v", "--verbose/--no-verbose", default=False,
               help="Print the Data that is passed to the template that "
               "generates the code")
 def api(db_file, library_name, node_name, force, encode_all_signals_func,
@@ -145,12 +208,18 @@ def api(db_file, library_name, node_name, force, encode_all_signals_func,
         rx_callback_context, tx_callback_context, msg_as_rx_callback_arg,
         rx_signal_store, with_rx_valid, msg_as_tx_callback_arg,
         tx_signal_store, time_as_rx_callback_arg, time_as_tx_callback_arg,
-        tx_function, prefix_signal_struct_names,
-        prefix_context_struct_names, verbose):
+        tx_function, tx_timing, prefix_signal_struct_names,
+        prefix_context_struct_names, seed, verbose):
     """
     Generate the static C API for NODE_NAME from DB_FILE (.kcd or .yaml)
     """
+    if seed is not None:
+        random.seed(seed)
     db_path = Path(db_file)
+    if tx_timing == "delta" and time_as_tx_callback_arg:
+        raise click.UsageError(
+            "--time-as-tx-callback-arg needs the absolute time and cannot be "
+            "combined with --tx-timing delta")
     try:
         basepath = Path(library_name)
         source_path = basepath.parent / f"{basepath.stem}.c"
@@ -217,6 +286,7 @@ def api(db_file, library_name, node_name, force, encode_all_signals_func,
         tx_function=tx_function,
         time_as_rx_callback_arg=time_as_rx_callback_arg,
         time_as_tx_callback_arg=time_as_tx_callback_arg,
+        tx_timing=tx_timing,
     )
     if not user_supplied_canframe:
         with (header_path.parent / 'canframe.h').open('w+') as canframe_header_file:
@@ -228,10 +298,11 @@ def api(db_file, library_name, node_name, force, encode_all_signals_func,
 
 
 @main.command()
+@config_option
 @click.argument("DB_File", type=click.Path(exists=True, dir_okay=False),
                 required=True, nargs=1)
 @click.argument("Output_Base", type=str, required=True)
-@click.option("-f", "--force", is_flag=True, required=False, default=False,
+@click.option("-f", "--force/--no-force", required=False, default=False,
               help="Overwrite existing output files")
 def cbdb(db_file, output_base, force):
     """
@@ -267,8 +338,9 @@ def cbdb(db_file, output_base, force):
 
 
 @main.command()
+@config_option
 @click.argument("Library_Name", type=str, required=True)
-@click.option("-f", "--force", is_flag=True, required=False, default=False,
+@click.option("-f", "--force/--no-force", required=False, default=False,
               help="Overwrite existing output files")
 @click.option("-im", "--id-member-name", type=str, default="arbitration_id",
               help="The name of the CanFrame struct member that holds the "

{can_api_generator-2.4.0 → can_api_generator-2.6.0}/src/can_api_generator/templates/header_template.jinja

@@ -47,17 +47,22 @@
 {%- endif %}
 {% endif %}
 {%- if periodic_tx %}
-{{ define_tx_context_struct(true, 'uint16_t', 'uint64_t', send_now, tx_callback_context=tx_callback_context, msg_as_tx_callback_arg=msg_as_tx_callback_arg, ctx_name=tx_context_struct_name, time_as_tx_callback_arg=time_as_tx_callback_arg) }}
+{{ define_tx_context_struct(true, 'uint16_t', 'uint64_t', send_now, tx_callback_context=tx_callback_context, msg_as_tx_callback_arg=msg_as_tx_callback_arg, ctx_name=tx_context_struct_name, time_as_tx_callback_arg=time_as_tx_callback_arg, tx_timing=tx_timing) }}
 
 {{ generate_global_tx_struct(messages, api_name_struct_prefix, double_buffered, tx_signal_store=tx_signal_store, ctx_name=tx_context_struct_name, can_frame_type=can_frame_type, tx_function=tx_function) }}
 
-{{ declare_periodic_tx_init_function(api_name, api_name_struct_prefix, 'uint64_t', can_frame_type, tx_function) }};
+{{ declare_periodic_tx_init_function(api_name, api_name_struct_prefix, 'uint64_t', can_frame_type, tx_function, tx_timing) }};
 
 {{ declare_get_msg_tx_context_by_id(messages, api_name, api_name_struct_prefix, 'struct ' ~ tx_context_struct_name) }};
 
-{{ declare_period_update_function(api_name, 'struct ' ~ tx_context_struct_name) }}
+{{ declare_period_update_function(api_name, 'struct ' ~ tx_context_struct_name, tx_timing) }}
+{%- if tx_timing == 'delta' %}
+
+{{ declare_periodic_tx_function(api_name, api_name_struct_prefix, can_frame_type, 'uint16_t', 'uint32_t', 'uint16_t', tx_function, 'dt') }};
+{%- else %}
 
 {{ declare_periodic_tx_function(api_name, api_name_struct_prefix, can_frame_type, 'uint16_t', 'uint64_t', 'uint16_t', tx_function) }};
+{%- endif %}
 {%- if double_buffered and tx_signal_store %}
 {%- for message in messages %}
 {%- if message.direction == 'tx' or message.direction == 'rt' %}

{can_api_generator-2.4.0 → can_api_generator-2.6.0}/src/can_api_generator/templates/source_template.jinja

@@ -7,6 +7,7 @@
 {% from "rx_macros.jinja" import generate_global_rx_frame_process_function -%}
 {% from "rx_macros.jinja" import define_global_rx_init_function -%}
 {% from "tx_macros.jinja" import define_periodic_tx_function -%}
+{% from "tx_macros.jinja" import define_periodic_tx_delta_function -%}
 {% from "tx_macros.jinja" import define_periodic_tx_init_function -%}
 {% from "tx_macros.jinja" import define_get_msg_tx_context_by_id -%}
 {% from "tx_macros.jinja" import define_commit_function -%}
@@ -21,12 +22,17 @@
 {%- endif %}
 {%- endif %}
 {%- if periodic_tx %}
+{%- if tx_timing == 'delta' %}
+
+{{ define_periodic_tx_delta_function(messages, api_name, api_name_struct_prefix, can_frame_type, 'uint16_t', 'uint16_t', true, send_now, double_buffered, tx_callback_context=tx_callback_context, msg_as_tx_callback_arg=msg_as_tx_callback_arg, tx_signal_store=tx_signal_store, tx_function=tx_function) }}
+{%- else %}
 
 {{ define_periodic_tx_function(messages, api_name, api_name_struct_prefix, can_frame_type, 'uint16_t', 'uint64_t', 'uint16_t', true, send_now, double_buffered, tx_callback_context=tx_callback_context, msg_as_tx_callback_arg=msg_as_tx_callback_arg, tx_signal_store=tx_signal_store, ctx_name=tx_context_struct_name, tx_function=tx_function, time_as_tx_callback_arg=time_as_tx_callback_arg) }}
+{%- endif %}
 
 {{ define_get_msg_tx_context_by_id(messages, api_name, api_name_struct_prefix, 'struct ' ~ tx_context_struct_name) }}
 
-{{ define_periodic_tx_init_function(api_name, api_name_struct_prefix, 'uint64_t', messages, '1000', double_buffered, tx_signal_store=tx_signal_store, can_frame_type=can_frame_type, tx_function=tx_function) }}
+{{ define_periodic_tx_init_function(api_name, api_name_struct_prefix, 'uint64_t', messages, '1000', double_buffered, tx_signal_store=tx_signal_store, can_frame_type=can_frame_type, tx_function=tx_function, tx_timing=tx_timing) }}
 {%- if double_buffered and tx_signal_store %}
 {%- for message in messages %}
 {%- if message.direction == 'tx' or message.direction == 'rt' %}