#pragma once #include #include #include "cJSON.h" #include "esp_err.h" #include "esp_http_server.h" // Helpers shared by the REST handlers (api.c and the res_*.c resource modules) // Path segments of "/res/id/action?query" (at most three) typedef char api_seg_t[3][64]; int api_split(const char *uri, api_seg_t seg); // Send obj as JSON; own=true deletes it afterwards esp_err_t api_json(httpd_req_t *req, const char *status, cJSON *obj, bool own); esp_err_t api_error(httpd_req_t *req, const char *status, const char *msg); esp_err_t api_message(httpd_req_t *req, const char *status, const char *msg); // 200 {message} for ESP_OK, otherwise a matching error status esp_err_t api_result(httpd_req_t *req, esp_err_t err, const char *ok_msg); // Parsed JSON object body, or NULL after an error response has been sent. api_body_opt treats an // empty body as {}. cJSON *api_body(httpd_req_t *req); cJSON *api_body_opt(httpd_req_t *req); // Shallow merge of src into dst, skipping "id" void api_merge(cJSON *dst, const cJSON *src); // Set (replace or add) one key void api_set(cJSON *obj, const char *key, cJSON *val); // Record id as text from a string or number value; false (buf empty) otherwise bool api_id(const cJSON *v, char *buf, size_t len); // Add rec under the collection's next id (with an "id" field when rec is an object); id gets the key void api_add(const char *coll, cJSON *rec, char *id, size_t len); // "aa:bb:..", "AA-BB-.." or "aabb.." -> lowercase 12-hex MAC; false when not a MAC bool api_mac(const cJSON *v, char out[13]); // device_config from the fields a request may set (name, num_leds, color_order, startup_mode); NULL when // none is valid. Caller owns the result. cJSON *api_driver_config(const cJSON *name, const cJSON *num_leds, const cJSON *color_order, const cJSON *startup); // Combined 0..255 brightness for a driver: global x its groups x device [x zone_b when >= 0] int api_effective_brightness(const char *mac, int zone_b); // Blink every member of a group, then "off" esp_err_t api_identify_group(const char *group_id); // New records with every field set (callers merge in the request) cJSON *api_preset_defaults(const char *profile_id); cJSON *api_sequence_defaults(void); // Current profile id (settings.current_profile_id, else the first profile), or NULL const char *api_current_profile(void); bool api_preset_in_profile(const cJSON *rec); // Bring records written by older versions into the current shape (at boot) void api_migrate_sequences(void); void api_seed_defaults(void); void api_migrate_zones(void); void api_migrate_groups(void); // Resource handlers, called with the store locked. Each returns true when it answered the request // (its result in *ret); false hands the request to the generic collection CRUD. bool bundles_route(httpd_req_t *req, int n, api_seg_t seg, esp_err_t *ret); bool profiles_route(httpd_req_t *req, int n, api_seg_t seg, esp_err_t *ret); bool zones_route(httpd_req_t *req, int n, api_seg_t seg, esp_err_t *ret); bool presets_route(httpd_req_t *req, int n, api_seg_t seg, esp_err_t *ret); bool palettes_route(httpd_req_t *req, int n, api_seg_t seg, esp_err_t *ret); bool sequences_route(httpd_req_t *req, int n, api_seg_t seg, esp_err_t *ret); bool groups_route(httpd_req_t *req, int n, api_seg_t seg, esp_err_t *ret); bool devices_route(httpd_req_t *req, int n, api_seg_t seg, esp_err_t *ret); bool patterns_route(httpd_req_t *req, int n, api_seg_t seg, esp_err_t *ret); bool outputs_route(httpd_req_t *req, int n, api_seg_t seg, esp_err_t *ret);