* @since_tizen 5.0
*/
typedef enum {
- IDM_CMD_TYPE_UNKNOWN = 0, /**< Unknown command */
- IDM_CMD_TYPE_POWER = 1, /**< Command regarding power */
- IDM_CMD_TYPE_DIAGNOSIS = 4, /**< Command regarding diagnosis */
- IDM_CMD_TYPE_INFO = 5, /**< Command regarding information */
+ IDM_CMD_REBOOT = 1, /**< Command for rebooting device */
+ IDM_CMD_GET_LOG_ARCHIVE, /**< Command for getting log archive file for diagnosis */
+ IDM_CMD_GET_TASKINFO, /**< Command for getting task information */
+ // IDM_CMD_GET_SYSINFO, /**< TBD : Command for getting system information */
+ // IDM_CMD_LCDOFF, /**< TBD : Command for turning LCD off */
+ // IDM_CMD_HIBERNATE, /**< TBD : Command for hibernating device */
+ // IDM_CMD_HALT, /**< TBD : Command for halting device */
+ // IDM_CMD_GET_ERR_CODE, /**< TBD : Command for getting error codes for diagnosis */
} idm_cmd_type_e;
/**
} idm_cmd_status_e;
/**
-* @brief Enumeration for command regarding power
-* @since_tizen 5.0
-*/
-typedef enum { /* TBD */
- IDM_CMD_POWER_REBOOT = 100, /**< Command for power rebooting */
- IDM_CMD_POWER_LCDOFF, /**< Command for turning LCD off */ /* TBD */
- IDM_CMD_POWER_HIBERNATE, /**< Command for hibernating on peak season */ /* TBD : Control electric power on the peak season */
- IDM_CMD_POWER_HALT, /**< Command for halting on peak season */ /* TBD : Control electric power on the peak season */
-} idm_cmd_power_e;
-
-/**
-* @brief Enumeration for command regarding diagnosis
-* @since_tizen 5.0
-*/
-typedef enum { /* TBD */
- IDM_CMD_DIAGNOSIS_GET_LOG_ARCHIVE = 400, /**< Command for getting logs for diagnosis */
- IDM_CMD_DIAGNOSIS_GET_ERR_CODE, /**< Command for getting error codes for diagnosis */ /* TBD : Collect error codes from sensors & motors */
-} idm_cmd_diagnosis_e;
-
-/**
-* @brief Enumeration for command regarding information
-* @since_tizen 5.0
-*/
-typedef enum { /* TBD */
- IDM_CMD_INFO_GET_SYSINFO = 500, /**< Command for getting system information */
- IDM_CMD_INFO_GET_TASKINFO, /**< Command for getting task information */ /* TBD : Add lots of things to a gateway so it needs to monitor resources. */
-} idm_cmd_info_e;
-
-/**
* @brief Enumeration for command result
* @since_tizen 5.0
*/
* @since_tizen 5.0
* @remarks This is not thread safe.
* This works asynchronously.
- * To use this API, the command must be perset by using idm_command_set_power_cmd(), idm_command_set_diagnosis_cmd(), idm_command_set_info_cmd().
+ * To use this API, the command must be preset by using idm_command_set_power_cmd(), idm_command_set_diagnosis_cmd(), idm_command_set_info_cmd().
* @param[in] command The idm_command handle
* @param[in] result_cb The callback function to get result
* @param[in] user_data The user data to be passed to the callback function
* @brief Stops the command.
* @since_tizen 5.0
* @remarks This is not thread safe.
- * If the command is not running, it returns a negative error value.
* @param[in] command The idm_command handle
* @return 0 on success, otherwise a negative error value
* @see idm_command_run()
/**
* @platfrom
- * @brief Sets the command regarding power
+ * @brief Sets the command for getting information
* @since_tizen 5.0
* @privlevel platform
- * @privilege http://tizen.org/privilege/reboot
- * @remarks This is not thread safe.
+ * @privilege %http://tizen.org/privilege/reboot
+ * @privilege %http://tizen.org/privilege/systemmonitor
+ * @remarks Required privilege depends on @p cmd \n
+ * #IDM_CMD_REBOOT requires privilege http://tizen.org/privilege/reboot \n
+ * #IDM_CMD_GET_TASKINFO requires privilege http://tizen.org/privilege/systemmonitor \n
+ * This is not thread safe.
* @param[in] command The idm_command handle
- * @param[in] cmd The command regarding power
- * @param[in] reason The reason for setting @cmd
+ * @param[in] cmd The command for getting information
+ * @param[in] detail The details for setting @p cmd
+ *
* @return 0 on success, otherwise a negative error value
- * @see idm_cmd_power_e
+ * @see idm_cmd_info_e
*
* @par Example
* @code
- * #include <libidm.h>
+ * #include <iot-device-manage.h>
+ * #include <iot-device-manage-type.h>
*
- * static void __reboot_result_callback(idm_command_h command, idm_result_e result, idm_reason_e reason, const char *detail, void *data)
+ * static void __result_cb(idm_command_h command, idm_result_e result, idm_reason_e reason, const char *detail, void *data)
* {
- * app_data *ad = data;
- * _D("result : %d, reason : %d, detail : %s", result, reason, detail ? detail : "None");
+ * unsigned long id;
+ * idm_command_get_id(command, &id);
+ *
+ * _D("[%d] result : %d, reason : %d, detail : %s", id, result, reason, detail ? detail : "None");
*
* if (result != IDM_RESULT_RUNNING) {
* idm_command_free(command);
* }
* }
*
- * static void __reboot(void)
+ * static void __get_taskinfo(const char *request, unsigned long id)
* {
* idm_command_h command = NULL;
* int ret = -1;
* return;
* }
*
- * ret = idm_command_set_power_cmd(command, IDM_CMD_POWER_REBOOT, NULL);
+ * idm_command_set_id(command, id);
+ *
+ * ret = idm_command_set_cmd_detail(command, IDM_CMD_GET_TASKINFO, request);
* if (ret != 0) {
- * _E("failed to idm_command_set_power_cmd");
+ * _E("failed to idm_command_set_cmd_detail");
* idm_command_free(command);
* return;
* }
*
- * ret = idm_command_run(command, __reboot_result_callback, ad);
+ * ret = idm_command_run(command, __result_cb, NULL);
* if (ret != 0) {
* _E("failed to idm_command_run");
* idm_command_free(command);
* }
* @endcode
*/
-int idm_command_set_power_cmd(idm_command_h command, idm_cmd_power_e cmd, const char* reason);
-
-/**
- * @brief Sets the command regarding diagnosis
- * @since_tizen 5.0
- * @remarks This is not thread safe.
- * @param[in] command The idm_command handle
- * @param[in] cmd The command regarding diagnosis
- * @param[in] detail The details for setting @cmd
- * @return 0 on success, otherwise a negative error value
- * @see idm_cmd_diagnosis_e
- */
-int idm_command_set_diagnosis_cmd(idm_command_h command, idm_cmd_diagnosis_e cmd, const char* detail);
-
-/**
- * @platfrom
- * @brief Sets the command for getting information
- * @since_tizen 5.0
- * @privlevel platform
- * @privilege http://tizen.org/privilege/systemmonitor
- * @remarks This is not thread safe.
- * @param[in] command The idm_command handle
- * @param[in] cmd The command for getting information
- * @param[in] detail The details for setting @cmd
- * @return 0 on success, otherwise a negative error value
- * @see idm_cmd_info_e
- *
- * @par Example
- * @code
- * #include <libidm.h>
- *
- * static void __result_cb(idm_command_h command, idm_result_e result, idm_reason_e reason, const char *detail, void *data)
- * {
- * unsigned long id;
- * idm_command_get_id(command, &id);
- *
- * _D("[%d] result : %d, reason : %d, detail : %s", id, result, reason, detail ? detail : "None");
- *
- * if (result != IDM_RESULT_RUNNING) {
- * idm_command_free(command);
- * }
- * }
- *
- * static void __get_taskinfo(char *request, unsigned long id)
- * {
- * idm_command_h command = NULL;
- * int ret = -1;
- *
- * idm_command_new(&command);
- * if (ret != 0) {
- * _E("failed to idm_command_new");
- * return;
- * }
- *
- * idm_command_set_id(command, id);
- *
- * ret = idm_command_set_info_cmd(command, IDM_CMD_INFO_GET_TASKINFO, request);
- * if (ret != 0) {
- * _E("failed to idm_command_set_info_cmd");
- * idm_command_free(command);
- * return;
- * }
- *
- * ret = idm_command_run(command, __result_cb, NULL);
- * if (ret != 0) {
- * _E("failed to idm_command_run");
- * idm_command_free(command);
- * return;
- * }
- * }
- * @endcode
- */
-int idm_command_set_info_cmd(idm_command_h command, idm_cmd_info_e cmd, const char* detail);
+int idm_command_set_cmd_detail(idm_command_h command, idm_cmd_type_e cmd, const char* detail);
#ifdef __cplusplus
}
projects / apps / native / iot-device-manager.git / commitdiff