release: update document

Author: yiweisong

HISTORY.md

@@ -1,8 +1,8 @@
 # History
 
 ---
-## 2.6.0 / TBD
-- [INS401] Support the new device.
+## 2.6.0 / 2021-10-11
+- [INS401] Support communication with ethernet 100base-t1 protocol.
 
 ## 2.5.0 / 2021-07-02
 - [DMU] Support firmware upgrade.

README.md

@@ -9,7 +9,7 @@ A message communication tool for OpenIMU, OpenRTK and other devices of Aceinna
 ## Steps
 
 ### 1. Start the tool
-There are 2 ways to run the tool
+There are 3 ways to run the tool
 
 #### Prepare
 1. Install the dependency library. It is better to create a virtual environment before to do it.
@@ -43,12 +43,24 @@ $ pyinstaller build.spec
 ```
 
 ##### Run
-```
+```bash
 $ cd dist
 $ ./ans-devices
 ```
 
-##### Startup Arguments
+#### C. From pip
+
+##### Install
+```bash
+$ pip install openimu
+```
+
+##### Run
+```
+$ openimu
+```
+
+#### Startup Arguments
 You can specify some arguments while run the tool
 
 Arguments:
@@ -153,21 +165,33 @@ Aceinna Device could be connected with your PC via UART or LAN. The supported in
 
 
 ## Parse Tool
-There is a log parse tool integrated in. It could parse OpenRTK and RTK330LA log from data folder. Assgin `parse` to start it.
-
-Example
-```bash
-$ ans-devices parse
-```
+There is a log parse tool integrated in. It could parse `OpenRTK`, `RTK330LA`, `IN S401` raw data log from data folder. Assgin `parse` to start it.
 
-Arguments:
+### Arguments:
 
 | Name | Type | Default | Description |
 | - | :-: | :-: | - |
 | -t | String | 'openrtk' | Switch work mode. Value should be one of `openrtk`,`rtkl`,`ins401` |
 | -p | String | '.' | Value should be a valid path. It could be the container folder of log files |
 | -i | Number | 5 | INS kml rate(hz) |
 
+### Example
+
+Run from source code
+```bash
+$ python main.py parse
+```
+
+Work as execution file
+```bash
+$ ans-devices parse
+```
+
+Run from pip
+```bash
+$ openimu parse
+```
+
 ## Changelogs and Release Notes
 
 Please refer to [HISTORY.md](HISTORY.md "Change History")

setup.py

@@ -21,15 +21,44 @@ def load_json_file_path_under_setting_folder():
     json_file_paths = []
     setting_root_path = os.path.join(os.getcwd(), 'src', 'aceinna', 'setting')
     for root, dirs, files in os.walk(setting_root_path):
-        json_file = next((item for item in files if item.__contains__('.json')), None)
+        json_file = next(
+            (item for item in files if item.__contains__('.json')), None)
         if not json_file:
             continue
 
-        json_file_path = os.path.join(root.replace(setting_root_path,'setting'), json_file)
+        json_file_path = os.path.join(root.replace(
+            setting_root_path, 'setting'), json_file)
         json_file_paths.append(json_file_path)
 
     return json_file_paths
 
+
+def load_libraries():
+    file_paths = []
+    setting_root_path = os.path.join(os.getcwd(), 'src', 'aceinna', 'libs')
+    for root, dirs, files in os.walk(setting_root_path):
+        for item in files:
+            lib_file = item if item.__contains__(
+                '.dll') or item.__contains__('.so') else None
+            if not lib_file:
+                continue
+
+            file_path = os.path.join(root.replace(
+                setting_root_path, 'libs'), lib_file)
+            file_paths.append(file_path)
+
+    return file_paths
+
+
+def load_resources():
+    resources = []
+    json_files = load_json_file_path_under_setting_folder()
+    lib_files = load_libraries()
+    resources.extend(json_files)
+    resources.extend(lib_files)
+    return resources
+
+
 PACKAGE_DESCRIPTION = "Aceinna Navigation System Open Devices Library"
 
 INSTALL_REQUIRES = [
@@ -55,7 +84,7 @@ def load_json_file_path_under_setting_folder():
     packages=find_packages("src", exclude=['test', 'tests']),
     package_dir={"": "src"},
     package_data={
-        'aceinna': load_json_file_path_under_setting_folder()
+        'aceinna': load_resources()
     },
     classifiers=[
         "Environment :: Console",