V3.1 Documentation and Interface Change Notes

This document applies only to A3-Ultra software version 3.1.x. Currently, only a limited set of documentation is available. Additional content, including motion APIs, expression playback APIs, and motion control simulation, will be released later.

V3.1 Documentation Updates

Date Update Content Latest AimDK Package
2026-06-29 A3-Ultra Developer Guide (v3.1) released
AimDK-A3_ultra-V3.1-0629
2026-07-30 Quick Start for Secondary Development content correction
7.7 System Status content correction
LinkSoul content added to the Interactive Secondary Development Guide
Internal/External microphone switch interface replaced
AimDK-A3_ultra-V3.1-0629

V3.1 Interface Change Notes

This changelog lists the API changes introduced in this version, as well as other updates that may significantly affect secondary development. Incompatible changes are highlighted in bold.

  1. Secondary Development Quick Start
    • Corrected the Python virtual environment creation command in 6.1.3, updating python -m venv mydev to python3 -m venv mydev
    • Added 6.4, an example for controlling robot actions
    • Added 6.5, a robot TTS speech playback example
  2. System Status
    • Corrected the content in 7.7 System Status, updating the BMS status and emergency stop status descriptions from RPC APIs to topic API descriptions
  3. Interaction Development
    • Added documentation for LinkSoul-related content
    • Added usage instructions for the face recognition result topic API
    • Added documentation for LinkSoul-related content
  4. Microphone Management
    • Updated the internal/external microphone switching API, replacing aimdk.protocol.AgentControlService/GetMicSourceRequest with aimdk.protocol.HalAudioService/SetMicSourceRequest
    • Corrected the description of the noise-reduction microphone audio retrieval API. Noise-reduced audio from the built-in microphone is currently unavailable and will be supported in a future release.
  5. Secondary Development Quick Start
    • Corrected the Python virtual environment creation command in 6.1.3, updating python -m venv mydev to python3 -m venv mydev
    • Added 6.4, an example for controlling robot actions
    • Added 6.5, a robot TTS speech playback example

Issue Feedback Channel

If you encounter bugs in the secondary development interfaces, you can submit feedback through the following channel:

https://agirobot.feishu.cn/share/base/form/shrcnLP2tv9gzyrZ2tSDlm1Baif

Note

This channel is only for questions and bug reports related to secondary development interfaces. For robot hardware failures, after-sales maintenance, or similar issues, please contact the relevant delivery, operations, or after-sales teams directly. Unrelated issues will not receive a response. Please describe the issue in detail in the form, preferably with reproducible steps. Reports with sufficient information and clear descriptions will be prioritized. Vague or overly general reports may be assigned lower priority and may be ignored. Please fill in all required information carefully. Tickets with inconsistent or casually entered information may be ignored. Each ticket should focus on a single issue or a single category of issues. Please do not combine multiple issues into one ticket, as this will significantly delay processing.