Troubleshooting
=================

This chapter covers common issues/faults and how to solve them.

Connection error message
---------------------------------

If the connection between AIDK client and NoemaEdge App is lost, the AIDK library instance will output **"No AI state received within timeout 3s!"**.


NoemaEdge error messages
------------------

It is recommended to check status of NoemaEdge App using ``AIDKClient::get_current_state`` before command. If an error occurs in NoemaEdge App, the error message will be returned in ``ai_status.status_message``.


AIDK error
--------------------------------------------

Detect error
~~~~~~~~~~~~~~~~~~~~~~~

In the process of ``AIDKClient::detect`` and ``AIDKClient::detect_v1x``, **"Error: AI detect failed!"** will be outputted if detect or detect_v1x failed.

There are also several error messages in the process of ``AIDKClient::parse_result``.

If **"obj_name"** in config file does not match that in InferApp.json,  **"invalid object name:xxx""** will be outputted.

If index of object number in ``AIDKClient::parse_result`` exceeds maximum num of detected object, **"invalid index: x, max number: x"** will be outputted.

If **"keys"** not in supported keys **["bbox", "keypoints", "positions", "obj_pose", "valid", "double_value", "int_value", "name"]**, **"Unsupported key: xxx"** will be outputted.

If **"keys"** in config file does not exist in detect result, **"Missing key: xxx"** or **"Invalid key: xxx"** will be outputted.


File transfer error
~~~~~~~~~~~~~~~~~~~~~~~

In the process of commands ``AIDKClient::list_remote_files``, ``AIDKClient::get_file_info``, ``AIDKClient::remove_path``, ``AIDKClient::make_remote_directory``, ``AIDKClient::read``, ``AIDKClient::make_remote_directory``, ``AIDKClient::read``, ``AIDKClient::write``, **"Error: error_msg"** will be outputted if current command failed to be executed in NoemaEdge App.

In the process of ``AIDKClient::send_file``, ``AIDKClient::send_folder``, runtime error like **"Local File/Directory not exist"** will be thrown out if file or folder does not exist in local.