Skip to content

Commit 7bf539d

Browse files
committed
update README.md
1 parent b26a564 commit 7bf539d

File tree

1 file changed

+101
-10
lines changed

1 file changed

+101
-10
lines changed

β€ŽREADME.md

Lines changed: 101 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,110 @@
1-
# Yaskawa communication SDK
1+
# Yaskawa Communication SDK
22

3-
Quickly create applications that communicate with a Yaskawa industrial robot.
3+
[![UnderAutomation Yaskawa communication SDK](https://raw.githubusercontent.com/underautomation/yaskawa.NET/refs/heads/main/.github/assets/banner.png)](https://underautomation.com)
44

5-
SDK : Software Development Kit
5+
[![NuGet](https://img.shields.io/nuget/dt/UnderAutomation.Yaskawa?label=NuGet%20Downloads&logo=nuget)](https://www.nuget.org/packages/UnderAutomation.Yaskawa/)
6+
[![.NET Framework](https://img.shields.io/badge/.NET_Framework-3.5+-blueviolet)](#)
7+
[![.NET Standard](https://img.shields.io/badge/.NET_Standard-2.0+-blueviolet)](#)
8+
[![.NET Core](https://img.shields.io/badge/.NET_Core-2.0+-blueviolet)](#)
9+
[![.NET Versions](https://img.shields.io/badge/.NET-5_6_8_9-blueviolet)](#)
610

7-
More information : [https://underautomation.com](https://underautomation.com)
11+
### πŸ€– Effortlessly Communicate with Yaskawa robots
812

9-
## Features
13+
The **Yaskawa SDK** enables seamless integration with Yaskawa robots for automation, data exchange, and remote control. Ideal for industrial automation, research, and advanced robotics applications.
1014

11-
## Examples
15+
πŸ”— **More Information:** [https://underautomation.com/yaskawa](https://underautomation.com/yaskawa)
16+
πŸ”— Also available for **[🟨 LabVIEW](https://github.com/underautomation/yaskawa.vi)** & **[🐍 Python](https://github.com/underautomation/yaskawa.py)**
1217

13-
Pre-built example applications with source code are provided for Winforms, .NET console, LabVIEW and Python.
18+
---
1419

15-
## License
20+
[⭐ Star if you like it !](https://github.com/underautomation/yaskawa.NET/stargazers)
1621

17-
This SDK is a commercial library and a license _must_ be purshased. Once acquired, any application you develop can be delivered to an unlimited number of customers without royalties and without recurring subscription.
22+
[πŸ‘οΈ Watch to be notified of latest updates !](https://github.com/underautomation/yaskawa.NET/watchers)
1823

19-
More information : [https://underautomation.com](https://underautomation.com)
24+
---
25+
26+
## πŸš€ TL;DR (Too Long; Didn’t Read)
27+
28+
No additional installations or Yaskawa options are required to use this SDK.
29+
30+
---
31+
32+
## πŸ“₯ Download Example Applications
33+
34+
Explore the **Yaskawa SDK** with fully functional example applications and precompiled binaries for various platforms. [See Github releases](https://github.com/underautomation/yaskawa.NET/releases)
35+
36+
### πŸ”Ή Windows Forms Application (Full Feature Showcase)
37+
38+
A Windows Forms application demonstrating all the features of the library.
39+
40+
πŸ“Œ **Download:** [πŸ“₯ UnderAutomation.Yaskawa.Showcase.Forms.exe](https://github.com/underautomation/yaskawa.NET/releases/latest/download/UnderAutomation.Yaskawa.Showcase.Forms.exe)
41+
42+
<p align="center">
43+
<img src="https://raw.githubusercontent.com/underautomation/yaskawa.NET/refs/heads/main/.github/assets/read-variables.gif" >
44+
<img src="https://raw.githubusercontent.com/underautomation/yaskawa.NET/refs/heads/main/.github/assets/move-robot.gif" >
45+
<img src="https://raw.githubusercontent.com/underautomation/yaskawa.NET/refs/heads/main/.github/assets/snpx.gif" >
46+
</p>
47+
48+
---
49+
50+
## πŸ“Œ Features
51+
52+
---
53+
54+
## πŸ›  Installation
55+
56+
### 1️⃣ **Get the SDK**
57+
58+
Choose the installation method that works best for you:
59+
60+
| Method | NuGet (Recommended) | Direct Download |
61+
| ------------------ | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
62+
| **How to Install** | Install via NuGet. [See on Nuget](https://www.nuget.org/packages/UnderAutomation.Yaskawa) | Download and reference the DLL manually |
63+
| | `dotnet add package UnderAutomation.Yaskawa ` | πŸ“₯ [Download ZIP](https://github.com/underautomation/yaskawa.NET/releases/latest/download/UnderAutomation.Yaskawa.zip) |
64+
65+
### 2️⃣ **Reference the SDK in Your Code**
66+
67+
```csharp
68+
using UnderAutomation.Yaskawa;
69+
```
70+
71+
### 3️⃣ **Connect to Your Robot**
72+
73+
```csharp
74+
var robot = new YaskawaRobot();
75+
robot.Connect(new ConnectParameters("192.168.0.1"));
76+
```
77+
78+
---
79+
80+
## πŸ” Compatibility
81+
82+
βœ… **Supported Robots:**
83+
βœ… **Operating Systems:** Windows, Linux, macOS
84+
βœ… **.NET Versions:** .NET Framework (β‰₯3.5), .NET Standard, .NET Core, .NET 5/6/8/9
85+
86+
---
87+
88+
## πŸ“’ Contributing
89+
90+
We welcome contributions! Feel free to:
91+
92+
- Report issues via [GitHub Issues](https://github.com/underautomation/Yaskawa.NET/issues)
93+
- Submit pull requests with improvements
94+
- Share feedback & feature requests
95+
96+
---
97+
98+
## πŸ“œ License
99+
100+
**⚠️ This SDK requires a commercial license.**
101+
πŸ”— Learn more: [UnderAutomation Licensing](https://underautomation.com/yaskawa/eula)
102+
103+
---
104+
105+
## πŸ“¬ Need Help?
106+
107+
If you have any questions or need support:
108+
109+
- πŸ“– **Check the Docs**: [Documentation](https://underautomation.com/yaskawa/documentation)
110+
- πŸ“© **Contact Us**: [Support](https://underautomation.com/contact)

0 commit comments

Comments
Β (0)