ESP RainMaker Programming Guide
Choose target...
Choose version...
C API Reference
Python API Reference
ESP RainMaker Programming Guide
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
E
|
F
|
G
|
H
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
U
A
add_user_for_sharing() (rmaker_lib.node.Node method)
add_user_node_mapping() (rmaker_lib.node.Node method)
add_user_to_share_nodes() (in module rmaker_cmd.node)
B
browser_login() (in module rmaker_cmd.browserlogin)
C
claim_node() (in module rmaker_cmd.node)
E
ESP_EVENT_DECLARE_BASE (C++ function)
esp_param_property_flags_t (C++ enum)
esp_rmaker_array (C++ function)
esp_rmaker_bool (C++ function)
esp_rmaker_brightness_param_create (C++ function)
esp_rmaker_cct_param_create (C++ function)
esp_rmaker_common_event_t (C++ enum)
esp_rmaker_config_t (C++ class)
esp_rmaker_config_t::enable_time_sync (C++ member)
ESP_RMAKER_CONFIG_VERSION (C macro)
esp_rmaker_console_init (C++ function)
esp_rmaker_create_local_control_service (C++ function)
esp_rmaker_create_mqtt_topic (C++ function)
esp_rmaker_create_scenes_service (C++ function)
esp_rmaker_create_schedule_service (C++ function)
esp_rmaker_create_system_service (C++ function)
ESP_RMAKER_DEF_BRIGHTNESS_NAME (C macro)
ESP_RMAKER_DEF_CCT_NAME (C macro)
ESP_RMAKER_DEF_DIRECTION_NAME (C macro)
ESP_RMAKER_DEF_FACTORY_RESET_NAME (C macro)
ESP_RMAKER_DEF_HUE_NAME (C macro)
ESP_RMAKER_DEF_INTENSITY_NAME (C macro)
ESP_RMAKER_DEF_LOCAL_CONTROL_POP (C macro)
ESP_RMAKER_DEF_LOCAL_CONTROL_TYPE (C macro)
ESP_RMAKER_DEF_NAME_PARAM (C macro)
ESP_RMAKER_DEF_OTA_INFO_NAME (C macro)
ESP_RMAKER_DEF_OTA_STATUS_NAME (C macro)
ESP_RMAKER_DEF_OTA_URL_NAME (C macro)
ESP_RMAKER_DEF_POWER_NAME (C macro)
ESP_RMAKER_DEF_REBOOT_NAME (C macro)
ESP_RMAKER_DEF_SATURATION_NAME (C macro)
ESP_RMAKER_DEF_SCENES_NAME (C macro)
ESP_RMAKER_DEF_SCHEDULE_NAME (C macro)
ESP_RMAKER_DEF_SPEED_NAME (C macro)
ESP_RMAKER_DEF_TEMPERATURE_NAME (C macro)
ESP_RMAKER_DEF_TIMEZONE_NAME (C macro)
ESP_RMAKER_DEF_TIMEZONE_POSIX_NAME (C macro)
ESP_RMAKER_DEF_WIFI_RESET_NAME (C macro)
esp_rmaker_device_add_attribute (C++ function)
esp_rmaker_device_add_cb (C++ function)
esp_rmaker_device_add_model (C++ function)
esp_rmaker_device_add_param (C++ function)
esp_rmaker_device_add_subtype (C++ function)
ESP_RMAKER_DEVICE_AIR_CONDITIONER (C macro)
esp_rmaker_device_assign_primary_param (C++ function)
ESP_RMAKER_DEVICE_BLINDS_EXTERNAL (C macro)
ESP_RMAKER_DEVICE_BLINDS_INTERNAL (C macro)
esp_rmaker_device_cb_src_to_str (C++ function)
esp_rmaker_device_create (C++ function)
esp_rmaker_device_delete (C++ function)
ESP_RMAKER_DEVICE_FAN (C macro)
ESP_RMAKER_DEVICE_GARAGE_DOOR (C macro)
ESP_RMAKER_DEVICE_GARAGE_LOCK (C macro)
esp_rmaker_device_get_name (C++ function)
esp_rmaker_device_get_param_by_name (C++ function)
esp_rmaker_device_get_param_by_type (C++ function)
esp_rmaker_device_get_type (C++ function)
ESP_RMAKER_DEVICE_LIGHT (C macro)
ESP_RMAKER_DEVICE_LIGHTBULB (C macro)
ESP_RMAKER_DEVICE_LOCK (C macro)
ESP_RMAKER_DEVICE_OTHER (C macro)
ESP_RMAKER_DEVICE_OUTLET (C macro)
ESP_RMAKER_DEVICE_PLUG (C macro)
esp_rmaker_device_read_cb_t (C++ type)
ESP_RMAKER_DEVICE_SOCKET (C macro)
ESP_RMAKER_DEVICE_SPEAKER (C macro)
ESP_RMAKER_DEVICE_SWITCH (C macro)
esp_rmaker_device_t (C++ type)
ESP_RMAKER_DEVICE_TEMP_SENSOR (C macro)
ESP_RMAKER_DEVICE_THERMOSTAT (C macro)
ESP_RMAKER_DEVICE_TV (C macro)
ESP_RMAKER_DEVICE_WASHER (C macro)
esp_rmaker_device_write_cb_t (C++ type)
esp_rmaker_direction_param_create (C++ function)
esp_rmaker_event_t (C++ enum)
esp_rmaker_factory_get (C++ function)
esp_rmaker_factory_get_size (C++ function)
esp_rmaker_factory_init (C++ function)
esp_rmaker_factory_reset (C++ function)
esp_rmaker_factory_reset_param_create (C++ function)
esp_rmaker_factory_set (C++ function)
esp_rmaker_fan_device_create (C++ function)
esp_rmaker_float (C++ function)
esp_rmaker_get_local_time_str (C++ function)
esp_rmaker_get_node (C++ function)
esp_rmaker_get_node_id (C++ function)
esp_rmaker_handle_t (C++ type)
esp_rmaker_hue_param_create (C++ function)
esp_rmaker_int (C++ function)
esp_rmaker_intensity_param_create (C++ function)
esp_rmaker_is_mqtt_connected (C++ function)
esp_rmaker_lightbulb_device_create (C++ function)
esp_rmaker_local_control_pop_param_create (C++ function)
esp_rmaker_local_control_type_param_create (C++ function)
esp_rmaker_local_ctrl_disable (C++ function)
esp_rmaker_local_ctrl_enable (C++ function)
esp_rmaker_local_ctrl_service_started (C++ function)
ESP_RMAKER_MAX_ALERT_LEN (C macro)
esp_rmaker_mqtt_connect (C++ function)
esp_rmaker_mqtt_deinit (C++ function)
esp_rmaker_mqtt_disconnect (C++ function)
esp_rmaker_mqtt_get_conn_params (C++ function)
esp_rmaker_mqtt_init (C++ function)
esp_rmaker_mqtt_is_budget_available (C++ function)
esp_rmaker_mqtt_publish (C++ function)
esp_rmaker_mqtt_setup (C++ function)
esp_rmaker_mqtt_subscribe (C++ function)
esp_rmaker_mqtt_unsubscribe (C++ function)
esp_rmaker_name_param_create (C++ function)
esp_rmaker_node_add_attribute (C++ function)
esp_rmaker_node_add_device (C++ function)
esp_rmaker_node_add_fw_version (C++ function)
esp_rmaker_node_add_model (C++ function)
esp_rmaker_node_add_subtype (C++ function)
esp_rmaker_node_auth_sign_msg (C++ function)
esp_rmaker_node_deinit (C++ function)
esp_rmaker_node_get_device_by_name (C++ function)
esp_rmaker_node_get_info (C++ function)
esp_rmaker_node_info_t (C++ class)
esp_rmaker_node_info_t::fw_version (C++ member)
esp_rmaker_node_info_t::model (C++ member)
esp_rmaker_node_info_t::name (C++ member)
esp_rmaker_node_info_t::secure_boot_digest (C++ member)
esp_rmaker_node_info_t::subtype (C++ member)
esp_rmaker_node_info_t::type (C++ member)
esp_rmaker_node_init (C++ function)
esp_rmaker_node_remove_device (C++ function)
esp_rmaker_node_t (C++ type)
esp_rmaker_obj (C++ function)
esp_rmaker_ota_cb_t (C++ type)
esp_rmaker_ota_config_t (C++ class)
esp_rmaker_ota_config_t::ota_cb (C++ member)
esp_rmaker_ota_config_t::ota_diag (C++ member)
esp_rmaker_ota_config_t::priv (C++ member)
esp_rmaker_ota_config_t::server_cert (C++ member)
esp_rmaker_ota_data_t (C++ class)
esp_rmaker_ota_data_t::filesize (C++ member)
esp_rmaker_ota_data_t::fw_version (C++ member)
esp_rmaker_ota_data_t::metadata (C++ member)
esp_rmaker_ota_data_t::ota_job_id (C++ member)
esp_rmaker_ota_data_t::priv (C++ member)
esp_rmaker_ota_data_t::server_cert (C++ member)
esp_rmaker_ota_data_t::url (C++ member)
esp_rmaker_ota_default_cb (C++ function)
esp_rmaker_ota_diag_priv_t (C++ class)
esp_rmaker_ota_diag_priv_t::rmaker_ota (C++ member)
esp_rmaker_ota_diag_priv_t::state (C++ member)
esp_rmaker_ota_diag_state_t (C++ enum)
esp_rmaker_ota_diag_status_t (C++ enum)
esp_rmaker_ota_enable (C++ function)
esp_rmaker_ota_enable_default (C++ function)
esp_rmaker_ota_event_t (C++ enum)
esp_rmaker_ota_fetch (C++ function)
esp_rmaker_ota_fetch_with_delay (C++ function)
esp_rmaker_ota_handle_t (C++ type)
esp_rmaker_ota_info_param_create (C++ function)
esp_rmaker_ota_mark_invalid (C++ function)
esp_rmaker_ota_mark_valid (C++ function)
esp_rmaker_ota_report_status (C++ function)
esp_rmaker_ota_service_create (C++ function)
esp_rmaker_ota_status_param_create (C++ function)
esp_rmaker_ota_type_t (C++ enum)
esp_rmaker_ota_url_param_create (C++ function)
ESP_RMAKER_PARAM_AC_MODE (C macro)
esp_rmaker_param_add_array_max_count (C++ function)
esp_rmaker_param_add_bounds (C++ function)
esp_rmaker_param_add_ui_type (C++ function)
esp_rmaker_param_add_valid_str_list (C++ function)
ESP_RMAKER_PARAM_BLINDS_POSITION (C macro)
ESP_RMAKER_PARAM_BRIGHTNESS (C macro)
ESP_RMAKER_PARAM_CCT (C macro)
esp_rmaker_param_create (C++ function)
ESP_RMAKER_PARAM_DIRECTION (C macro)
ESP_RMAKER_PARAM_FACTORY_RESET (C macro)
ESP_RMAKER_PARAM_GARAGE_POSITION (C macro)
esp_rmaker_param_get_name (C++ function)
esp_rmaker_param_get_type (C++ function)
esp_rmaker_param_get_val (C++ function)
ESP_RMAKER_PARAM_HUE (C macro)
ESP_RMAKER_PARAM_INTENSITY (C macro)
ESP_RMAKER_PARAM_LIGHT_MODE (C macro)
ESP_RMAKER_PARAM_LOCAL_CONTROL_POP (C macro)
ESP_RMAKER_PARAM_LOCAL_CONTROL_TYPE (C macro)
ESP_RMAKER_PARAM_MODE (C macro)
ESP_RMAKER_PARAM_NAME (C macro)
ESP_RMAKER_PARAM_OTA_INFO (C macro)
ESP_RMAKER_PARAM_OTA_STATUS (C macro)
ESP_RMAKER_PARAM_OTA_URL (C macro)
ESP_RMAKER_PARAM_POWER (C macro)
ESP_RMAKER_PARAM_RANGE (C macro)
ESP_RMAKER_PARAM_REBOOT (C macro)
ESP_RMAKER_PARAM_SATURATION (C macro)
ESP_RMAKER_PARAM_SCENES (C macro)
ESP_RMAKER_PARAM_SCHEDULES (C macro)
ESP_RMAKER_PARAM_SPEED (C macro)
esp_rmaker_param_t (C++ type)
ESP_RMAKER_PARAM_TEMPERATURE (C macro)
ESP_RMAKER_PARAM_TIMEZONE (C macro)
ESP_RMAKER_PARAM_TIMEZONE_POSIX (C macro)
ESP_RMAKER_PARAM_TOGGLE (C macro)
esp_rmaker_param_update (C++ function)
esp_rmaker_param_update_and_notify (C++ function)
esp_rmaker_param_update_and_report (C++ function)
esp_rmaker_param_val_t (C++ class)
esp_rmaker_param_val_t::type (C++ member)
esp_rmaker_param_val_t::val (C++ member)
ESP_RMAKER_PARAM_WIFI_RESET (C macro)
esp_rmaker_post_ota_diag_t (C++ type)
esp_rmaker_power_param_create (C++ function)
esp_rmaker_raise_alert (C++ function)
esp_rmaker_read_ctx_t (C++ class)
esp_rmaker_read_ctx_t::src (C++ member)
esp_rmaker_reboot (C++ function)
esp_rmaker_reboot_param_create (C++ function)
esp_rmaker_report_node_details (C++ function)
ESP_RMAKER_REQ_SRC_CLOUD (C++ enumerator)
ESP_RMAKER_REQ_SRC_INIT (C++ enumerator)
ESP_RMAKER_REQ_SRC_LOCAL (C++ enumerator)
ESP_RMAKER_REQ_SRC_MAX (C++ enumerator)
ESP_RMAKER_REQ_SRC_SCENE_ACTIVATE (C++ enumerator)
ESP_RMAKER_REQ_SRC_SCENE_DEACTIVATE (C++ enumerator)
ESP_RMAKER_REQ_SRC_SCHEDULE (C++ enumerator)
esp_rmaker_req_src_t (C++ enum)
esp_rmaker_saturation_param_create (C++ function)
esp_rmaker_scenes_enable (C++ function)
esp_rmaker_scenes_param_create (C++ function)
esp_rmaker_schedule_enable (C++ function)
esp_rmaker_schedules_param_create (C++ function)
esp_rmaker_service_create (C++ function)
ESP_RMAKER_SERVICE_LOCAL_CONTROL (C macro)
ESP_RMAKER_SERVICE_OTA (C macro)
ESP_RMAKER_SERVICE_SCENES (C macro)
ESP_RMAKER_SERVICE_SCHEDULE (C macro)
ESP_RMAKER_SERVICE_SYSTEM (C macro)
ESP_RMAKER_SERVICE_TIME (C macro)
esp_rmaker_speed_param_create (C++ function)
esp_rmaker_start (C++ function)
esp_rmaker_start_user_node_mapping (C++ function)
esp_rmaker_stop (C++ function)
esp_rmaker_str (C++ function)
esp_rmaker_switch_device_create (C++ function)
esp_rmaker_system_serv_config_t (C++ class)
esp_rmaker_system_serv_config_t::flags (C++ member)
esp_rmaker_system_serv_config_t::reboot_seconds (C++ member)
esp_rmaker_system_serv_config_t::reset_reboot_seconds (C++ member)
esp_rmaker_system_serv_config_t::reset_seconds (C++ member)
esp_rmaker_system_service_enable (C++ function)
esp_rmaker_temp_sensor_device_create (C++ function)
esp_rmaker_temperature_param_create (C++ function)
esp_rmaker_test_cmd_resp (C++ function)
esp_rmaker_time_check (C++ function)
esp_rmaker_time_config (C++ class)
esp_rmaker_time_config::sntp_server_name (C++ member)
esp_rmaker_time_config::sync_time_cb (C++ member)
esp_rmaker_time_config_t (C++ type)
esp_rmaker_time_get_timezone (C++ function)
esp_rmaker_time_get_timezone_posix (C++ function)
esp_rmaker_time_service_create (C++ function)
esp_rmaker_time_set_timezone (C++ function)
esp_rmaker_time_set_timezone_posix (C++ function)
esp_rmaker_time_sync_init (C++ function)
esp_rmaker_time_wait_for_sync (C++ function)
esp_rmaker_timezone_param_create (C++ function)
esp_rmaker_timezone_posix_param_create (C++ function)
esp_rmaker_timezone_service_enable (C++ function)
ESP_RMAKER_UI_DROPDOWN (C macro)
ESP_RMAKER_UI_HIDDEN (C macro)
ESP_RMAKER_UI_HUE_CIRCLE (C macro)
ESP_RMAKER_UI_HUE_SLIDER (C macro)
ESP_RMAKER_UI_PUSHBUTTON (C macro)
ESP_RMAKER_UI_SLIDER (C macro)
ESP_RMAKER_UI_TEXT (C macro)
ESP_RMAKER_UI_TOGGLE (C macro)
ESP_RMAKER_UI_TRIGGER (C macro)
ESP_RMAKER_USER_MAPPING_DONE (C++ enumerator)
esp_rmaker_user_mapping_endpoint_create (C++ function)
esp_rmaker_user_mapping_endpoint_register (C++ function)
ESP_RMAKER_USER_MAPPING_REQ_SENT (C++ enumerator)
ESP_RMAKER_USER_MAPPING_RESET (C++ enumerator)
ESP_RMAKER_USER_MAPPING_STARTED (C++ enumerator)
esp_rmaker_user_mapping_state_t (C++ enum)
esp_rmaker_user_node_mapping_get_state (C++ function)
esp_rmaker_val_t (C++ union)
esp_rmaker_val_t::b (C++ member)
esp_rmaker_val_t::f (C++ member)
esp_rmaker_val_t::i (C++ member)
esp_rmaker_val_t::s (C++ member)
esp_rmaker_val_type_t (C++ enum)
esp_rmaker_wifi_reset (C++ function)
esp_rmaker_wifi_reset_param_create (C++ function)
esp_rmaker_work_fn_t (C++ type)
esp_rmaker_work_queue_add_task (C++ function)
esp_rmaker_work_queue_deinit (C++ function)
esp_rmaker_work_queue_init (C++ function)
esp_rmaker_work_queue_start (C++ function)
esp_rmaker_work_queue_stop (C++ function)
esp_rmaker_write_ctx_t (C++ class)
esp_rmaker_write_ctx_t::src (C++ member)
F
forgot_password() (in module rmaker_cmd.user)
(rmaker_lib.user.User method)
G
get_mapping_status() (rmaker_lib.node.Node method)
get_mqtt_host() (in module rmaker_cmd.node)
(rmaker_lib.session.Session method)
get_node_config() (in module rmaker_cmd.node)
(rmaker_lib.node.Node method)
get_node_params() (rmaker_lib.node.Node method)
get_node_status() (in module rmaker_cmd.node)
(rmaker_lib.node.Node method)
get_nodeid() (rmaker_lib.node.Node method)
get_nodes() (in module rmaker_cmd.node)
(rmaker_lib.session.Session method)
get_params() (in module rmaker_cmd.node)
get_password() (in module rmaker_cmd.user)
get_shared_nodes_request() (rmaker_lib.node.Node method)
get_sharing_details_of_nodes() (rmaker_lib.node.Node method)
get_user_details() (in module rmaker_cmd.user)
(rmaker_lib.session.Session method)
H
handle_otp_based_login() (rmaker_lib.user.User method)
L
list_sharing_details() (in module rmaker_cmd.node)
login() (in module rmaker_cmd.user)
(rmaker_lib.user.User method)
logout() (in module rmaker_cmd.user)
(rmaker_lib.session.Session method)
M
MEM_ALLOC_EXTRAM (C macro)
MEM_CALLOC_EXTRAM (C macro)
MEM_REALLOC_EXTRAM (C macro)
N
Node (class in rmaker_lib.node)
O
OTA_DIAG_STATE_INIT (C++ enumerator)
OTA_DIAG_STATE_POST_MQTT (C++ enumerator)
OTA_DIAG_STATUS_FAIL (C++ enumerator)
OTA_DIAG_STATUS_PENDING (C++ enumerator)
OTA_DIAG_STATUS_SUCCESS (C++ enumerator)
OTA_STATUS_DELAYED (C++ enumerator)
OTA_STATUS_FAILED (C++ enumerator)
OTA_STATUS_IN_PROGRESS (C++ enumerator)
OTA_STATUS_REJECTED (C++ enumerator)
OTA_STATUS_SUCCESS (C++ enumerator)
ota_status_t (C++ enum)
ota_upgrade() (in module rmaker_cmd.node)
OTA_USING_PARAMS (C++ enumerator)
OTA_USING_TOPICS (C++ enumerator)
P
PROP_FLAG_PERSIST (C++ enumerator)
PROP_FLAG_READ (C++ enumerator)
PROP_FLAG_SIMPLE_TIME_SERIES (C++ enumerator)
PROP_FLAG_TIME_SERIES (C++ enumerator)
PROP_FLAG_WRITE (C++ enumerator)
provision() (in module rmaker_cmd.provision)
R
remove_node() (in module rmaker_cmd.node)
remove_shared_nodes_request() (rmaker_lib.node.Node method)
remove_sharing() (in module rmaker_cmd.node)
remove_user_from_shared_nodes() (rmaker_lib.node.Node method)
remove_user_node_mapping() (rmaker_lib.node.Node method)
request_op() (rmaker_lib.node.Node method)
rmaker_cmd.browserlogin (module)
rmaker_cmd.node (module)
rmaker_cmd.provision (module)
rmaker_cmd.user (module)
RMAKER_EVENT_CLAIM_FAILED (C++ enumerator)
RMAKER_EVENT_CLAIM_STARTED (C++ enumerator)
RMAKER_EVENT_CLAIM_SUCCESSFUL (C++ enumerator)
RMAKER_EVENT_FACTORY_RESET (C++ enumerator)
RMAKER_EVENT_INIT_DONE (C++ enumerator)
RMAKER_EVENT_LOCAL_CTRL_STARTED (C++ enumerator)
RMAKER_EVENT_LOCAL_CTRL_STOPPED (C++ enumerator)
RMAKER_EVENT_REBOOT (C++ enumerator)
RMAKER_EVENT_TZ_CHANGED (C++ enumerator)
RMAKER_EVENT_TZ_POSIX_CHANGED (C++ enumerator)
RMAKER_EVENT_USER_NODE_MAPPING_DONE (C++ enumerator)
RMAKER_EVENT_USER_NODE_MAPPING_RESET (C++ enumerator)
RMAKER_EVENT_WIFI_RESET (C++ enumerator)
rmaker_lib.node (module)
rmaker_lib.session (module)
rmaker_lib.user (module)
RMAKER_MQTT_EVENT_CONNECTED (C++ enumerator)
RMAKER_MQTT_EVENT_DISCONNECTED (C++ enumerator)
RMAKER_MQTT_EVENT_MSG_DELETED (C++ enumerator)
RMAKER_MQTT_EVENT_PUBLISHED (C++ enumerator)
RMAKER_OTA_EVENT_DELAYED (C++ enumerator)
RMAKER_OTA_EVENT_FAILED (C++ enumerator)
RMAKER_OTA_EVENT_IN_PROGRESS (C++ enumerator)
RMAKER_OTA_EVENT_INVALID (C++ enumerator)
RMAKER_OTA_EVENT_REJECTED (C++ enumerator)
RMAKER_OTA_EVENT_REQ_FOR_REBOOT (C++ enumerator)
RMAKER_OTA_EVENT_STARTING (C++ enumerator)
RMAKER_OTA_EVENT_SUCCESSFUL (C++ enumerator)
RMAKER_VAL_TYPE_ARRAY (C++ enumerator)
RMAKER_VAL_TYPE_BOOLEAN (C++ enumerator)
RMAKER_VAL_TYPE_FLOAT (C++ enumerator)
RMAKER_VAL_TYPE_INTEGER (C++ enumerator)
RMAKER_VAL_TYPE_INVALID (C++ enumerator)
RMAKER_VAL_TYPE_OBJECT (C++ enumerator)
RMAKER_VAL_TYPE_STRING (C++ enumerator)
S
Session (class in rmaker_lib.session)
set_node_params() (rmaker_lib.node.Node method)
set_params() (in module rmaker_cmd.node)
sharing_request_op() (in module rmaker_cmd.node)
signup() (in module rmaker_cmd.user)
(rmaker_lib.user.User method)
signup_request() (rmaker_lib.user.User method)
SYSTEM_SERV_FLAG_FACTORY_RESET (C macro)
SYSTEM_SERV_FLAG_REBOOT (C macro)
SYSTEM_SERV_FLAG_WIFI_RESET (C macro)
SYSTEM_SERV_FLAGS_ALL (C macro)
U
User (class in rmaker_lib.user)