QuecPython · supremeys · Oct 12, 2024 · Oct 12, 2024
diff --git a/README.md b/README.md
@@ -10,9 +10,13 @@ The main SNMP operations include GET, used to request device information; SET, u
 
 ## Usage
 
-- [API_Reference](./docs/en/API_Reference.md)
-- [Sample Code](./code/snmp_api.py)
-- [SNMP Documentation](./docs/en/SNMP_Documentation.md)
+- [SNMP Client API Reference](./client/docs/en/SNMP_Client_API_Reference.md)
+- [SNMP Client Sample Code](./client/snmp_api.py)
+- [SNMP Client Documentation](./client/docs/en/SNMP_Client_Documentation.md)
+
+- [SNMP Agent API Reference](./server/docs/en/SNMP_Agent_API_Reference.md)
+- [SNMP Agent Sample Code](./server/snmp_agent.py)
+- [SNMP Agent Documentation](./server/docs/en/SNMP_Agent_Documentation.md)
 
 ## Contribution
 

diff --git a/README_ZH.md b/README_ZH.md
@@ -1,6 +1,6 @@
 # QuecPython SNMP协议
 
-中文| [English](./README.md) 
+中文| [English](./README.md)
 
 ## 概述
 
@@ -10,9 +10,13 @@ SNMP主要操作包括GET，用于请求设备信息；SET，用于修改设备
 
 ## 用法
 
-- [API说明文档](./docs/zh/API说明文档.md)
-- [示例代码](./code/snmp_api.py)
-- [SNMP使用文档](./docs/zh/SNMP使用文档.md)
+- [SNMP客户端API说明文档](./client/docs/zh/SNMP客户端API说明文档.md)
+- [SNMP客户端示例代码](./client/snmp_api.py)
+- [SNMP客户端使用文档](./client/docs/zh/SNMP客户端使用文档.md)
+
+- [SNMP代理端API说明文档](./server/docs/zh/SNMP代理端API说明文档.md)
+- [SNMP代理端示例代码](./server/snmp_agent.py)
+- [SNMP代理端使用文档](./server/docs/zh/SNMP代理端使用文档.md)
 
 ## 贡献
 

diff --git a/docs/en/API_Reference.md → client/docs/en/SNMP_Client_API_Reference.md b/docs/en/API_Reference.md → client/docs/en/SNMP_Client_API_Reference.md
@@ -1,4 +1,4 @@
-# QuecPython SNMP API Documentation
+# QuecPython SNMP Client API Documentation
 
 This module contains high-level functions for accessing the SNMP library.
 

diff --git a/docs/en/SNMP_Documentation.md → client/docs/en/SNMP_Client_Documentation.md b/docs/en/SNMP_Documentation.md → client/docs/en/SNMP_Client_Documentation.md
@@ -1,4 +1,4 @@
-# QuecPython SNMP Documentation
+# QuecPython SNMP Client Documentation
 
 ### Introduction to SNMP
 

diff --git a/docs/media/image-20240705095053302.png → ...nt/docs/media/image-20240705095053302.png b/docs/media/image-20240705095053302.png → ...nt/docs/media/image-20240705095053302.png
diff --git a/docs/zh/API说明文档.md → client/docs/zh/SNMP客户端API说明文档.md b/docs/zh/API说明文档.md → client/docs/zh/SNMP客户端API说明文档.md
@@ -1,4 +1,4 @@
-# QuecPython SNMP API说明文档
+# QuecPython SNMP 客户端API说明文档
 
 该模块包含访问snmp库的高级函数
 

diff --git a/docs/zh/SNMP使用文档.md → client/docs/zh/SNMP客户端使用文档.md b/docs/zh/SNMP使用文档.md → client/docs/zh/SNMP客户端使用文档.md
@@ -1,4 +1,4 @@
-# QuecPython SNMP 使用文档
+# QuecPython SNMP 客户端使用文档
 
 ### SNMP简介
 

diff --git a/code/hmac.py → client/hmac.py b/code/hmac.py → client/hmac.py
diff --git a/code/snmp_api.py → client/snmp_api.py b/code/snmp_api.py → client/snmp_api.py
diff --git a/code/snmp_auth.py → client/snmp_auth.py b/code/snmp_auth.py → client/snmp_auth.py
diff --git a/code/snmp_common.py → client/snmp_common.py b/code/snmp_common.py → client/snmp_common.py
diff --git a/code/snmp_priv.py → client/snmp_priv.py b/code/snmp_priv.py → client/snmp_priv.py
diff --git a/code/snmp_type.py → client/snmp_type.py b/code/snmp_type.py → client/snmp_type.py
diff --git a/code/snmp_utils.py → client/snmp_utils.py b/code/snmp_utils.py → client/snmp_utils.py
diff --git a/server/docs/en/SNMP_Agent_API_Reference.md b/server/docs/en/SNMP_Agent_API_Reference.md
@@ -0,0 +1,55 @@
+# QuecPython SNMP Agent API Documentation
+
+## API Description
+
+### SNMPAgent
+
+> This module includes agent services such as Get, Set, Trap, etc. Before use, a SNMP Agent instance needs to be created.
+
+**Example:**
+
+```python
+from usr.snmp_agent import SNMPAgent
+import dataCall
+host = dataCall.getInfo(1, 0)[2][2]
+post = 161
+agent = SNMPAgent(host, post)
+```
+
+**Parameters:**
+
+|Parameter|Type|Explain|
+|:---|---|---|
+|host|str|Current network IP, such as '10.221.171.193'|
+|post|int|Network port, such as 161|
+
+#### SNMPAgent.serve_forever
+
+> Start the agent service.
+
+**Example:**
+
+```python
+agent.serve_forever()
+```
+
+#### SNMPAgent.send_trap
+
+> The agent actively sends Trap messages.
+
+**Example:**
+
+```python
+trap_oid = '1.3.6.1.4.1.9999.1.6.0'
+trap_value = b'Trap Event Triggered'
+trap_ip='192.168.1.100'
+agent.send_trap(trap_oid, trap_value, trap_ip)
+```
+
+**Parameters:**
+
+| Parameter | Type  | Explain           |
+| :--- | ----- | -------------- |
+| trap_oid  | str   | OID of Trap message |
+| trap_value | str | The value of the Trap message |
+| trap_ip | str | IP address for receiving Trap messages |
diff --git a/server/docs/en/SNMP_Agent_Documentation.md b/server/docs/en/SNMP_Agent_Documentation.md
@@ -0,0 +1,192 @@
+# QuecPython SNMP Agent Documentation
+
+## Introduction
+
+This document introduces how to run the tracker solution program we provided on modules or devices. The operations demonstrated in this document are based on Quectel EG915U series module.
+
+## Get Resource
+
+Resources can be downloaded from: https://github.com/QuecPython/snmp
+
+## Set up Environment
+
+### Install USB Driver
+
+Please download and install the driver according to the platform of the module to be debugged. [Click here to download USB Drivers](https://python.quectel.com/en/download)
+
+![snmp_agent-en-1](../media/snmp_agent-en-1.png)
+
+### Download Development and Debugging Tool
+
+It is recommended to use QPYcom for development and debugging. The processes described in this document are under the premise that QPYcom is used and USB driver installation is successful.
+
+[Click here to download QPYcom](https://python.quectel.com/en/download)
+
+![snmp_agent-en-2](../media/snmp_agent-en-2.png)
+
+[Click here to view QPYcom User Guide](https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/index.html)
+
+### Download Firmware
+
+Download the corresponding QuecPython firmware according to the current debugging module model from the QuecPython official website, and download the firmware into the module with QPYcom.
+
+[Click here to download firmware](https://python.quectel.com/en/download)
+
+![snmp_agent-en-3](../media/snmp_agent-en-3.png)
+
+Use QPYcom to download firmware.
+
+1. Select firmware
+
+![snmp_agent-en-4](../media/snmp_agent-en-4.png)
+
+2. Download firmware
+
+![snmp_agent-en-5](../media/snmp_agent-en-5.png)
+
+3. Wait for the completion of firmware download
+
+![snmp_agent-en-6](../media/snmp_agent-en-6.png)
+
+4. Successful download
+
+![snmp_agent-en-7](../media/snmp_agent-en-7.png)
+
+5. Connect to the interactive port
+
+![snmp_agent-en-8](../media/snmp_agent-en-8.png)
+
+6. View the download information
+
+![snmp_agent-en-9](../media/snmp_agent-en-9.png)
+
+### Download Code
+
+- When downloading the code via USB, you need to reserve a USB port or test point for the device. Or you can use an EVB for debugging, and install the driver in advance.
+
+1. Select "**`Quectel USB NMEA PORT`**". This serial port is for interaction, and QPYcom logs will also be output through this serial port.
+
+![snmp_agent-en-10](../media/snmp_agent-en-10.png)
+
+2. Download the business functional code to the device in batches. Click "**Download script**" and wait for the download to complete. After the download is complete, view the result on the "File" page.
+
+![snmp_agent-en-11](../media/snmp_agent-en-11.png)
+
+3. After successful download, it is recommended to reboot the device and run the function
+
+![snmp_agent-en-12](../media/snmp_agent-en-12.png)
+
+4. View the running result
+
+![snmp_agent-en-13](../media/snmp_agent-en-13.png)
+
+## Instructions
+
+### 1.Burn firmware and scripts into the module
+
+You can operate according to the environment construction chapter.
+
+Specific steps can also refer to:
+
+[Firmware burning - QuecPython (quectel.com)](https://python.quectel.com/doc/Getting_started/en/flash_firmware.html)
+
+[Script burning - QuecPython (quectel.com)](https://python.quectel.com/doc/Getting_started/en/first_python.html)
+
+### 2.Run snmp_agent_v3
+
+The printed host is followed by the agent address "10.239.139.149".
+
+```python
+import example
+example.exec('/usr/snmp_agent.py')
+# host: 10.239.139.149
+# [net] Network connection successful.
+# sleep 3s to ensure that the server starts successfully.
+# SNMP Agent is running on 10.239.139.149 : 161 ...
+```
+
+### 3.Create Client v3 object
+
+1.The client side needs to establish a connection with the agent side, so the address needs to be the same, which is "10.239.139.149".
+
+2.After establishing a connection, corresponding data can be transmitted using the client's get and set and the agent's trap.
+
+```python
+from usr.snmp_api import Client, V3
+from usr.snmp_api import ObjectIdentifier as OID
+from usr.snmp_api import OctetString
+client = Client("10.239.139.149", V3("public"), port=161)
+client.get("1.3.6.1.4.1.9999.1.1.7")
+#Received SNMP request from data: b'0>\x02\x01\x030\x11\x02\x04f\xee\x9f\xa1\x02\x03\x01\x00\x01\x04\x01\x04\x02\x01\x03\x04\x100\x0e\x04\x00\x02\x01\x00\x02\x01\x00\x04\x00\x04\x00\x04\x000\x14\x04\x00\x04\x00\xa0\x0e\x02\x04f\xee\x9f\xa1\x02\x01\x00\x02\x01\x000\x00' datalen: 64 addr: ('10.239.139.149', 56584)
+#new_value: b'' value_length: 0
+#snmp_response: b'0S\x02\x01\x030\x11\x02\x04f\xee\x9f\xa1\x02\x03\x01\x00\x00\x04\x01\x00\x02\x01\x03\x04\x1f0\x1d\x04\x0f869487060565057\x02\x01\x00\x02\x01\x00\x04\x00\x04\x00\x04\x000\x1a\x04\x00\x04\x00\xa2\x14\x02\x04f\xee\x9f\xa1\x02\x01\x00\x02\x01\x000\x060\x04\x06\x00\x04\x00'
+#Received SNMP request from data: b'0r\x02\x01\x030\x11\x02\x04f\xee\x9f\xa1\x02\x03\x01\x00\x01\x04\x01\x04\x02\x01\x03\x04%0#\x04\x0f869487060565057\x02\x01\x00\x02\x01\x00\x04\x06public\x04\x00\x04\x0003\x04\x0f869487060565057\x04\x00\xa0\x1e\x02\x04f\xee\x9f\xa1\x02\x01\x00\x02\x01\x000\x100\x0e\x06\n+\x06\x01\x04\x01\xce\x0f\x01\x01\x07\x05\x00' datalen: 116 addr: ('10.239.139.149', 56585)
+#oid_values: Reboot readresult: 0 objresult: 0 value: False
+#new_value: False value_length: 5
+#snmp_response: b'0w\x02\x01\x030\x11\x02\x04f\xee\x9f\xa1\x02\x03\x01\x00\x00\x04\x01\x00\x02\x01\x03\x04%0#\x04\x0f869487060565057\x02\x01\x00\x02\x01\x00\x04\x06public\x04\x00\x04\x0008\x04\x0f869487060565057\x04\x00\xa2#\x02\x04f\xee\x9f\xa1\x02\x01\x00\x02\x01\x000\x150\x13\x06\n+\x06\x01\x04\x01\xce\x0f\x01\x01\x07\x04\x05False'
+#GetResponse(1726914465, [VarBind(oid=ObjectIdentifier(value = 1.3.6.1.4.1.9999.1.1.7), value=OctetString(value = b'False'))])
+client.set(OID("1.3.6.1.4.1.9999.1.1.7"), OctetString(b'False'))
+#Received SNMP request from data: b'0w\x02\x01\x030\x11\x02\x04f\xee\x9f\xf3\x02\x03\x01\x00\x01\x04\x01\x00\x02\x01\x03\x04%0#\x04\x0f869487060565057\x02\x01\x00\x02\x01\x00\x04\x06public\x04\x00\x04\x0008\x04\x0f869487060565057\x04\x00\xa3#\x02\x04f\xee\x9f\xf3\x02\x01\x00\x02\x01\x000\x150\x13\x06\n+\x06\x01\x04\x01\xce\x0f\x01\x01\x07\x04\x05False' datalen: 121 addr: ('10.239.139.149', 56586)
+#oid_values: Reboot readresult: 0 objresult: 0 value: 0
+#new_value: b'False' value_length: 5
+#snmp_response: b'0w\x02\x01\x030\x11\x02\x04f\xee\x9f\xf3\x02\x03\x01\x00\x00\x04\x01\x00\x02\x01\x03\x04%0#\x04\x0f869487060565057\x02\x01\x00\x02\x01\x00\x04\x06public\x04\x00\x04\x0008\x04\x0f869487060565057\x04\x00\xa2#\x02\x04f\xee\x9f\xf3\x02\x01\x00\x02\x01\x000\x150\x13\x06\n+\x06\x01\x04\x01\xce\x0f\x01\x01\x07\x04\x05False'
+#OctetString(value = b'False')
+agent.trigger_trap_event()
+# SNMPv3 Trap sent to 192.168.1.100:162
+```
+
+## OID
+
+Custom oids can be added to the `__init__` of the `SNPAgent` script within the `snmp.agent` script.
+
+```python
+self.oid_values = {
+    '1.3.6.1.4.1.9999.1.1.7': 'Reboot',
+    '1.3.6.1.4.1.9999.1.2.0': 'keepAliveDuration',
+    '1.3.6.1.4.1.9999.1.3.2': 'Operator',
+    '1.3.6.1.4.1.9999.1.4.0': 'APN',
+    '1.3.6.1.4.1.9999.1.5.0': 'pwshute_en',
+}
+```
+
+### client get
+
+Just input the corresponding OID directly. For example:
+
+```python
+# Reboot
+client.get("1.3.6.1.4.1.9999.1.1.7")
+# keepAliveDuration
+client.get("1.3.6.1.4.1.9999.1.2.0")
+# Operator
+client.get("1.3.6.1.4.1.9999.1.3.2")
+# APN
+client.get("1.3.6.1.4.1.9999.1.4.0")
+# pwshute_en
+client.get("1.3.6.1.4.1.9999.1.5.0")
+```
+
+### client set
+
+The first parameter needs to be passed in with an OID object, and the second parameter needs to be passed in with the corresponding configuration using OctetString. For example:
+
+```python
+# Reboot Bool type, but transmission requires passing a string, False: Will not restart; True: Restart
+client.set(OID("1.3.6.1.4.1.9999.1.1.7"), OctetString(b'False'))
+# keepAliveDuration Int type, but transmission requires passing in a string, set the number of seconds to keep the connection active
+client.set(OID("1.3.6.1.4.1.9999.1.2.0"), OctetString(b'0'))
+# Operator Tuple type, no permission to set, transmission will fail
+client.set(OID("1.3.6.1.4.1.9999.1.3.2"), OctetString(b'('CHN-UNICOM', 'UNICOM', '460', '01')'))
+# APN Str type, just pass it in directly, set the APN information
+client.set(OID("1.3.6.1.4.1.9999.1.4.0"), OctetString(b'3gnet,,'))
+# pwshute_en Bool type, but transmission requires passing a string, False: Trap not enabled; True: Enable trap
+client.set(OID("1.3.6.1.4.1.9999.1.5.0"), OctetString(b'False'))
+```
+
+### agent trap
+
+```python
+# Trap Event Triggered
+agent.trigger_trap_event()
+```
+
diff --git a/server/docs/media/snmp_agent-1.png b/server/docs/media/snmp_agent-1.png
diff --git a/server/docs/media/snmp_agent-10.png b/server/docs/media/snmp_agent-10.png
diff --git a/server/docs/media/snmp_agent-11.png b/server/docs/media/snmp_agent-11.png
diff --git a/server/docs/media/snmp_agent-12.png b/server/docs/media/snmp_agent-12.png
diff --git a/server/docs/media/snmp_agent-13.png b/server/docs/media/snmp_agent-13.png
diff --git a/server/docs/media/snmp_agent-2.png b/server/docs/media/snmp_agent-2.png
diff --git a/server/docs/media/snmp_agent-3.png b/server/docs/media/snmp_agent-3.png
diff --git a/server/docs/media/snmp_agent-4.png b/server/docs/media/snmp_agent-4.png
diff --git a/server/docs/media/snmp_agent-5.png b/server/docs/media/snmp_agent-5.png
diff --git a/server/docs/media/snmp_agent-6.png b/server/docs/media/snmp_agent-6.png
diff --git a/server/docs/media/snmp_agent-7.png b/server/docs/media/snmp_agent-7.png
diff --git a/server/docs/media/snmp_agent-8.png b/server/docs/media/snmp_agent-8.png
diff --git a/server/docs/media/snmp_agent-9.png b/server/docs/media/snmp_agent-9.png
diff --git a/server/docs/media/snmp_agent-en-1.png b/server/docs/media/snmp_agent-en-1.png
diff --git a/server/docs/media/snmp_agent-en-10.png b/server/docs/media/snmp_agent-en-10.png
diff --git a/server/docs/media/snmp_agent-en-11.png b/server/docs/media/snmp_agent-en-11.png
diff --git a/server/docs/media/snmp_agent-en-12.png b/server/docs/media/snmp_agent-en-12.png
diff --git a/server/docs/media/snmp_agent-en-13.png b/server/docs/media/snmp_agent-en-13.png
diff --git a/server/docs/media/snmp_agent-en-2.png b/server/docs/media/snmp_agent-en-2.png
diff --git a/server/docs/media/snmp_agent-en-3.png b/server/docs/media/snmp_agent-en-3.png
diff --git a/server/docs/media/snmp_agent-en-4.png b/server/docs/media/snmp_agent-en-4.png
diff --git a/server/docs/media/snmp_agent-en-5.png b/server/docs/media/snmp_agent-en-5.png
diff --git a/server/docs/media/snmp_agent-en-6.png b/server/docs/media/snmp_agent-en-6.png
diff --git a/server/docs/media/snmp_agent-en-7.png b/server/docs/media/snmp_agent-en-7.png
diff --git a/server/docs/media/snmp_agent-en-8.png b/server/docs/media/snmp_agent-en-8.png
diff --git a/server/docs/media/snmp_agent-en-9.png b/server/docs/media/snmp_agent-en-9.png
diff --git a/server/docs/zh/SNMP代理端API说明文档.md b/server/docs/zh/SNMP代理端API说明文档.md
@@ -0,0 +1,55 @@
+# QuecPython SNMP 代理端API说明文档
+
+## API 说明
+
+### SNMPAgent
+
+> 该模块包含代理端Get、Set、Trap等服务，使用前需要创建一个SNMPAgent实例。
+
+**示例：**
+
+```python
+from usr.snmp_agent import SNMPAgent
+import dataCall
+host = dataCall.getInfo(1, 0)[2][2]
+post = 161
+agent = SNMPAgent(host, post)
+```
+
+**参数：**
+
+|参数|类型|说明|
+|:---|---|---|
+|host|str|当前网络IP，例如'10.221.171.193'|
+|post|int|网络端口，例如161|
+
+#### SNMPAgent.serve_forever
+
+> 启动代理端服务。
+
+**示例：**
+
+```python
+agent.serve_forever()
+```
+
+#### SNMPAgent.send_trap
+
+> 代理端主动发送Trap消息。
+
+**示例：**
+
+```python
+trap_oid = '1.3.6.1.4.1.9999.1.6.0'
+trap_value = b'Trap Event Triggered'
+trap_ip='192.168.1.100'
+agent.send_trap(trap_oid, trap_value, trap_ip)
+```
+
+**参数：**
+
+| 参数 | 类型  | 说明           |
+| :--- | ----- | -------------- |
+| trap_oid  | str   | Trap消息的OID |
+| trap_value | str | Trap消息的值 |
+| trap_ip | str | 接收Trap消息的IP地址 |