ticos-agent 0.4.0

Ticos Agent

Ticos Agent

What is Ticos?

Ticos is an advanced Embodied AI platform for Humanoid Robotics. It provides a comprehensive suite of tools and frameworks for developing, deploying, and managing intelligent systems for humanoid robots. The Ticos Agent is a crucial component of this ecosystem, responsible for collecting and transmitting data from robotic systems to the Ticos cloud infrastructure.

Overview

The Ticos Agent is an extensible, efficient, and secure data collection and transmission system designed for robotic applications, with a focus on humanoid robotics. It serves as the bridge between the physical robot and the Ticos cloud platform, enabling real-time monitoring, analytics, and AI-driven decision making.

Features

• Real-time system information collection
• Extensible architecture for custom data collection modules
• Secure and efficient data transmission
• Configurable data collection intervals
• Support for running as a daemon process
• Easy-to-use command-line interface

Installation

To install the Ticos Agent, you can use pip:

pip install ticos-agent

Or clone the repository and install:

git clone https://github.com/tiwater/ticos-agent.git
cd ticos-agent
pip install .

Configuration

The Ticos Agent uses a YAML configuration file. By default, it looks for /etc/ticos_agent.conf. Here's an example configuration:

# Default path for custom robots
custom_robots_path: examples/custom_robots
api_url: https://dash.ticos.ai
api_key: <api-key> # You can create one on dash.ticos.ai
# device_id: 1 # Optional, if not provided, the mac address of the current device will be used.

# Telemetry configuration
telemetry:
  exporter: console # Options: otlp, logging, file
  # otlp_endpoint: http://localhost:4318/v1/traces # Only used if exporter is otlp

devices:
  # - name: yan_robot
  #   type: builtin
  #   model: yan
  #   class_name: YanRobot
  - name: desktop_agent
    type: builtin
    model: desktop
    class_name: DesktopAgent
  # - name: custom_mock_robot
  #   type: custom
  #   path: mock_robot.robot
  #   class_name: MockRobot

collect_interval: 5
send_interval: 5

Usage

To run the Ticos Agent:

ticos-agent --config /path/to/config.yaml

To run as a daemon:

ticos-agent --config /path/to/config.yaml --daemon

Extending the Ticos Agent

The Ticos Agent supports custom extensions for data collection. To create an extension:

1. Create a Python file in the extensions_dir specified in your config.
2. Implement the DeviceInterface as shown below.

class DeviceInterface(ABC):
    @abstractmethod
    def get_device_info(self):
        pass

    @abstractmethod
    def collect_data(self):
        pass

    @abstractmethod
    def execute_command(self, command_name, **kwargs):
        pass

You can look into folder examples/custom_robots/ for robot examples, or src/ticos_agent/robots for builtin robots.

Contributing

We welcome contributions to the Ticos Agent! Please see our Contributing Guide for more details.

License

The Ticos Agent is released under the MIT License.

Support

For support, please open an issue on our GitHub repository or contact our support team at [e-mail].

Acknowledgements

The Ticos Agent is developed and maintained by the Tiwater Intelligent Cloud OS team. We thank all our contributors and the open-source community for their valuable input and support.