File espos_n2k_api.h¶

FileList > espos_n2k > include > espos_n2k_api.h

#include "esp_err.h"

Public Functions¶

Type	Name
esp_err_t	espos_n2k_api_register (const void * receiver) Register GET /api/v1/n2k, reporting `receiver` 's counters.

Public Functions Documentation¶

function espos_n2k_api_register¶

Register GET /api/v1/n2k, reporting receiver 's counters.

esp_err_t espos_n2k_api_register (
    const void * receiver
)

Call after espos_httpd_start() and after the receiver exists; the receiver must outlive the server, which the usual static at file scope gives. ESP_ERR_NOT_SUPPORTED when the firmware has no espos_httpd.

The document answers the question a candump socket cannot: whether the driver is up, whether anything has ever arrived, how long ago, and whether the controller is seeing bus errors it cannot make frames out of.

The documentation for this class was generated from the following file espos_n2k/include/espos_n2k_api.h