README: Document interval key in reports #129

atse · 2024-08-16T13:44:24+08:00

atse commented

2024-08-16 13:44:24 +08:00

The interval key in reports somehow went undocumented. For reference, right now, a report for a channel looks like this:

{
    "channel": 0,
    "time": 5.527388e3,
    "interval": 1.2e-1,
    "adc": 8.021930745447365e-1,
    "sens": 9.651217883084013e3,
    "temperature": 2.583279432442754e1,
    "pid_engaged": false,
    "i_set": 0e0,
    "dac_value": 1.5000171662031794e0,
    "dac_feedback": 1.497e0,
    "i_tec": 1.5030000000000001e0,
    "tec_i": 5.0000000000000044e-3,
    "tec_u_meas": -3.9999999999995595e-3,
    "pid_output": 0e0
}

It is useful for PID autotune, where the time difference from the last sample is relevant.

The `interval` key in reports somehow went undocumented. For reference, right now, a report for a channel looks like this: ```json { "channel": 0, "time": 5.527388e3, "interval": 1.2e-1, "adc": 8.021930745447365e-1, "sens": 9.651217883084013e3, "temperature": 2.583279432442754e1, "pid_engaged": false, "i_set": 0e0, "dac_value": 1.5000171662031794e0, "dac_feedback": 1.497e0, "i_tec": 1.5030000000000001e0, "tec_i": 5.0000000000000044e-3, "tec_u_meas": -3.9999999999995595e-3, "pid_output": 0e0 } ``` It is useful for PID autotune, where the time difference from the last sample is relevant.

atse added 1 commit 2024-08-16 13:44:24 +08:00

c5674343a1 README: Document interval key in reports

sb10q merged commit 47fa9f757e into master

2024-10-16 11:15:29 +08:00

Sign in to join this conversation.

No reviewers

No Label

No Milestone

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: M-Labs/thermostat#129