Skip to content

Commit bce1af0

Browse files
committed
docs: update README.md
1 parent 4d0afec commit bce1af0

File tree

1 file changed

+62
-23
lines changed

1 file changed

+62
-23
lines changed

packages/plugin-depin/README.md

+62-23
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,25 @@
11
# `@elizaos/plugin-depin`
22

3-
The **`@elizaos/plugin-depin`** plugin empowers the Eliza Agent Framework with **Perception** and **Action** capabilities via DePINs, bridging the digital intelligence of AI with the physical world.
3+
The **`@elizaos/plugin-depin`** plugin empowers the Eliza Agent Framework with **Perception** and **Action** capabilities via **Decentralized Physical Infrastructure Networks (DePINs)**, bridging the digital intelligence of AI with the physical world.
44

5-
- **DePINs as "Senses and Actuators":** Enables real-time data access from decentralized sensors and control over physical devices.
5+
- **DePINs as "Senses and Actuators":** Enables real-time data access from decentralized sensors and control over physical devices, making DePINs the sensory organs and actuators for Eliza agents.
66
- **Unlock Transformative Use Cases:** From drone delivery to smart city infrastructure and precision agriculture, this plugin extends your AI agents' potential.
7+
- **Foundation for Sentient AI:** Facilitates contextual awareness, predictive capabilities, and goal-oriented behavior based on real-world sensory input and continuous feedback loops.
78

8-
Leverage **`@elizaos/plugin-depin`** to integrate AI agents with the real world seamlessly.
9+
Leverage **`@elizaos/plugin-depin`** to seamlessly integrate AI agents with the real world, enabling them to **perceive, act, and learn**.
10+
11+
---
12+
13+
## Key Features
14+
15+
1. **Seamless IoTeX Integration:**
16+
- Leverages IoTeX Modular Infra to connect to a growing ecosystem of DePIN networks.
17+
2. **Unified Data Access:**
18+
- Standardized interfaces allow access to diverse DePIN data sources, regardless of protocols or formats.
19+
3. **Time-Series Data Handling:**
20+
- Equipped to analyze temporal patterns for predictive capabilities.
21+
4. **Future-Proof Design:**
22+
- Designed to scale with the evolving DePIN and AI landscape.
923

1024
---
1125

@@ -22,44 +36,69 @@ NUBILA_API_KEY=your-nubila-api-key
2236

2337
### Character Configuration
2438

25-
Update character.json with the following:
39+
Update `character.json` with the following configuration to enable the plugin:
2640

2741
```json
2842
"plugins": [
2943
"@elizaos/plugin-depin"
3044
]
3145
```
3246

47+
This ensures that the **`@elizaos/plugin-depin`** plugin is loaded and operational within your Eliza Agent Framework, enabling seamless integration with DePIN networks and their data.
48+
49+
---
50+
3351
## Providers
3452

3553
### DePINScan
3654

37-
The DePINScan provider fetches and caches data from the IoTeX DePINScan API, providing:
55+
The **DePINScan provider** bridges the gap between your Eliza agents and decentralized physical infrastructure. By fetching and caching data from the DePINScan API, it provides actionable insights such as:
3856

39-
- **Daily Metrics**: Latest aggregated statistics about DePIN activity on IoTeX
40-
- **Project Data**: Detailed information about DePIN projects including:
41-
- Project name and slug
42-
- Token details and market metrics
43-
- Device statistics (total devices, costs, earnings)
44-
- Layer 1 chains and categories
45-
- Market data (market cap, token price, FDV)
57+
- **Daily Metrics:** Get the latest statistics on DePIN activity, including device operations and network performance.
58+
- **Project Data:** Detailed information about individual DePIN projects:
59+
- **Project Identifiers:** Names and slugs for easy referencing.
60+
- **Token Information:** Market metrics such as token prices, market caps, and fully diluted valuations (FDV).
61+
- **Device Statistics:** Total devices deployed, operational costs, and earnings.
62+
- **Blockchain Integration:** Layer 1 chains associated with projects and their respective categories.
63+
- **Market Insights:** Comprehensive data on market trends and project capitalization.
64+
65+
---
4666

4767
## Actions
4868

49-
### Depin Projects
69+
### DePIN Projects
5070

51-
The DEPIN_PROJECTS action analyzes and provides information about DePIN projects tracked by DePINScan. It can:
71+
The **DEPIN_PROJECTS** action empowers Eliza agents to interact with and analyze DePIN project data, enabling:
5272

53-
- Query token prices, market caps, and valuations
54-
- Compare metrics between different projects
55-
- Filter projects by categories and chains
56-
- Provide device statistics and earnings data
57-
- Answer questions about specific project details
73+
- **Token Metrics Queries:** Retrieve token prices, market capitalizations, and valuations for projects.
74+
- **Project Comparisons:** Compare key metrics across multiple DePIN projects.
75+
- **Filtering Capabilities:** Refine results by project categories or supported blockchain platforms.
76+
- **Device and Revenue Analysis:** Explore statistics such as device deployment, operational costs, and revenue generation.
77+
- **In-depth Queries:** Answer detailed questions about specific DePIN projects by leveraging the rich dataset provided by the DePINScan API.
5878

5979
### Current Weather and Weather Forecast
6080

61-
The CURRENT_WEATHER action fetches and analyzes weather data for a given location using Mapbox and Nubila APIs. It can:
81+
The **CURRENT_WEATHER** action integrates Nubila APIs to provide Eliza agents with weather-related capabilities. Key functionalities include:
82+
83+
- **Real-Time Weather Updates:** Deliver current temperature, humidity, and general conditions for specified locations.
84+
- **Forecast Analysis:** Generate short- and long-term forecasts to assist in planning and decision-making.
85+
- **Pattern Recognition:** Analyze weather trends and identify emerging patterns or anomalies.
86+
- **Interactive Content:** Create weather-related insights, summaries, or user-facing content such as memes and visuals.
87+
88+
---
89+
90+
## Sentient AI with DePIN Integration
91+
92+
The **`@elizaos/plugin-depin`** plugin is a critical component in the evolution of Eliza agents into sentient systems that are aware of and responsive to their physical environments. By integrating with DePINs, this plugin enables AI agents to:
93+
94+
- **Perceive:** Access sensory data streams from devices across decentralized networks, including environmental sensors, location trackers, and motion detectors.
95+
- **Act:** Influence and control connected devices in real-time, unlocking a wide array of use cases from logistics to urban management.
96+
- **Learn:** Build predictive models and goal-oriented behaviors using continuous feedback from real-world data sources.
97+
98+
### Transformative Applications
99+
100+
From smart city infrastructure and autonomous vehicle systems to precision agriculture and environmental monitoring, the **`@elizaos/plugin-depin`** unlocks new frontiers in AI development. By merging decentralized infrastructure with AI-driven perception and action, this plugin empowers agents to act not just in virtual spaces but in the physical world.
101+
102+
With its **future-proof design** and seamless integration capabilities, the **`@elizaos/plugin-depin`** is an essential tool for developers looking to push the boundaries of AI and decentralized systems.
62103

63-
- Provide current temperature, weather conditions, and forecasts
64-
- Answer questions about weather patterns and trends
65-
- Generate weather-themed memes and images
104+
Start building the next generation of AI-powered applications with **`@elizaos/plugin-depin`** and redefine what’s possible for intelligent agents in the real world.

0 commit comments

Comments
 (0)