UnderAutomation.Fanuc 2.0.0.1__py3-none-any.whl

underautomation/fanuc/telnet/kcl_ports.py

@@ -0,0 +1,17 @@
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import KCLPorts as kcl_ports
+
+class KCLPorts(int):
+	DIN = kcl_ports.DIN
+	DOUT = kcl_ports.DOUT
+	RDO = kcl_ports.RDO
+	OPOUT = kcl_ports.OPOUT
+	TPOUT = kcl_ports.TPOUT
+	WDI = kcl_ports.WDI
+	WDO = kcl_ports.WDO
+	AIN = kcl_ports.AIN
+	AOUT = kcl_ports.AOUT
+	GIN = kcl_ports.GIN
+	GOUT = kcl_ports.GOUT

underautomation/fanuc/telnet/message_received_event_args.py

@@ -0,0 +1,21 @@
+import typing
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import MessageReceivedEventArgs as message_received_event_args
+
+class MessageReceivedEventArgs:
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = message_received_event_args()
+		else:
+			self._instance = _internal
+	@property
+	def is_reset(self) -> bool:
+		return self._instance.IsReset
+	@property
+	def message(self) -> str:
+		return self._instance.Message
+	@message.setter
+	def message(self, value: str):
+		self._instance.Message = value

underautomation/fanuc/telnet/pause_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.result import Result
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import PauseResult as pause_result
+
+class PauseResult(Result):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = pause_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/program_command_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.result import Result
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import ProgramCommandResult as program_command_result
+
+class ProgramCommandResult(Result):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = program_command_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/raw_data_received_event_args.py

@@ -0,0 +1,18 @@
+import typing
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import RawDataReceivedEventArgs as raw_data_received_event_args
+
+class RawDataReceivedEventArgs:
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = raw_data_received_event_args()
+		else:
+			self._instance = _internal
+	@property
+	def data(self) -> str:
+		return self._instance.Data
+	@data.setter
+	def data(self, value: str):
+		self._instance.Data = value

underautomation/fanuc/telnet/remove_breakpoint_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.result import Result
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import RemoveBreakpointResult as remove_breakpoint_result
+
+class RemoveBreakpointResult(Result):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = remove_breakpoint_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/reset_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.result import Result
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import ResetResult as reset_result
+
+class ResetResult(Result):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = reset_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/result.py

@@ -0,0 +1,23 @@
+import typing
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import Result as result
+
+class Result:
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = result()
+		else:
+			self._instance = _internal
+	def __repr__(self):
+		return self._instance.ToString()
+	@property
+	def error_text(self) -> str:
+		return self._instance.ErrorText
+	@property
+	def succeed(self) -> bool:
+		return self._instance.Succeed
+	@property
+	def kcl_command(self) -> str:
+		return self._instance.KclCommand

underautomation/fanuc/telnet/run_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.program_command_result import ProgramCommandResult
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import RunResult as run_result
+
+class RunResult(ProgramCommandResult):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = run_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/set_port_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.set_value_result import SetValueResult
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import SetPortResult as set_port_result
+
+class SetPortResult(SetValueResult):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = set_port_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/set_value_result.py

@@ -0,0 +1,21 @@
+import typing
+from underautomation.fanuc.telnet.result import Result
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import SetValueResult as set_value_result
+
+class SetValueResult(Result):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = set_value_result()
+		else:
+			self._instance = _internal
+	def __repr__(self):
+		return self._instance.ToString()
+	@property
+	def former_value(self) -> str:
+		return self._instance.FormerValue
+	@property
+	def new_value(self) -> str:
+		return self._instance.NewValue

underautomation/fanuc/telnet/set_variable_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.set_value_result import SetValueResult
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import SetVariableResult as set_variable_result
+
+class SetVariableResult(SetValueResult):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = set_variable_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/simulate_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.base_result import BaseResult
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import SimulateResult as simulate_result
+
+class SimulateResult(BaseResult):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = simulate_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/step_off_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.result import Result
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import StepOffResult as step_off_result
+
+class StepOffResult(Result):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = step_off_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/step_on_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.result import Result
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import StepOnResult as step_on_result
+
+class StepOnResult(Result):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = step_on_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/task_information_result.py

@@ -0,0 +1,47 @@
+import typing
+from underautomation.fanuc.common.task_status import TaskStatus
+from underautomation.fanuc.common.program_type import ProgramType
+from underautomation.fanuc.telnet.result import Result
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import TaskInformationResult as task_information_result
+
+class TaskInformationResult(Result):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = task_information_result()
+		else:
+			self._instance = _internal
+	def __repr__(self):
+		return self._instance.ToString()
+	@property
+	def task_name(self) -> str:
+		return self._instance.TaskName
+	@property
+	def task_number(self) -> int:
+		return self._instance.TaskNumber
+	@property
+	def task_status_str(self) -> str:
+		return self._instance.TaskStatusStr
+	@property
+	def task_status(self) -> TaskStatus:
+		return TaskStatus(self._instance.TaskStatus)
+	@property
+	def routine_name(self) -> str:
+		return self._instance.RoutineName
+	@property
+	def current_line(self) -> int:
+		return self._instance.CurrentLine
+	@property
+	def program_type(self) -> ProgramType:
+		return ProgramType(self._instance.ProgramType)
+	@property
+	def hold_conditions(self) -> str:
+		return self._instance.HoldConditions
+	@property
+	def invisible_task(self) -> bool:
+		return self._instance.InvisibleTask
+	@property
+	def system_task(self) -> bool:
+		return self._instance.SystemTask

underautomation/fanuc/telnet/telnet_client.py

@@ -0,0 +1,15 @@
+import typing
+from underautomation.fanuc.telnet.internal.telnet_client_base import TelnetClientBase
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import TelnetClient as telnet_client
+
+class TelnetClient(TelnetClientBase):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = telnet_client()
+		else:
+			self._instance = _internal
+	def connect(self, ip: str, telnetKclPassword: str) -> None:
+		self._instance.Connect(ip, telnetKclPassword)

underautomation/fanuc/telnet/tp_coordinates.py

@@ -0,0 +1,12 @@
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import TpCoordinates as tp_coordinates
+
+class TpCoordinates(int):
+	Unknown = tp_coordinates.Unknown
+	Tool = tp_coordinates.Tool
+	User = tp_coordinates.User
+	Joint = tp_coordinates.Joint
+	JogFrame = tp_coordinates.JogFrame
+	World = tp_coordinates.World

underautomation/fanuc/telnet/tp_coordinates_received_event_args.py

@@ -0,0 +1,19 @@
+import typing
+from underautomation.fanuc.telnet.tp_coordinates import TpCoordinates
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import TpCoordinatesReceivedEventArgs as tp_coordinates_received_event_args
+
+class TpCoordinatesReceivedEventArgs:
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = tp_coordinates_received_event_args()
+		else:
+			self._instance = _internal
+	@property
+	def coord(self) -> TpCoordinates:
+		return TpCoordinates(self._instance.Coord)
+	@coord.setter
+	def coord(self, value: TpCoordinates):
+		self._instance.Coord = value

underautomation/fanuc/telnet/unsimulate_all_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.base_result import BaseResult
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import UnsimulateAllResult as unsimulate_all_result
+
+class UnsimulateAllResult(BaseResult):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = unsimulate_all_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/unsimulate_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.base_result import BaseResult
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import UnsimulateResult as unsimulate_result
+
+class UnsimulateResult(BaseResult):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = unsimulate_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/variable_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.result import Result
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import VariableResult as variable_result
+
+class VariableResult(Result):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = variable_result()
+		else:
+			self._instance = _internal

underautomation/fanuc/telnet/variables_result.py

@@ -0,0 +1,13 @@
+import typing
+from underautomation.fanuc.telnet.result import Result
+import clr
+import os
+clr.AddReference(os.path.realpath(os.path.join(os.path.dirname(__file__), "..",  'lib', 'UnderAutomation.Fanuc.dll')))
+from UnderAutomation.Fanuc.Telnet import VariablesResult as variables_result
+
+class VariablesResult(Result):
+	def __init__(self, _internal = 0):
+		if(_internal == 0):
+			self._instance = variables_result()
+		else:
+			self._instance = _internal

underautomation_fanuc-2.0.0.1.dist-info/METADATA

@@ -0,0 +1,210 @@
+Metadata-Version: 2.4
+Name: UnderAutomation.Fanuc
+Version: 2.0.0.1
+Summary: Quickly create applications that communicate with your Fanuc robots
+Home-page: https://underautomation.com/fanuc
+Author: UnderAutomation
+Author-email: support@underautomation.com
+Project-URL: Documentation, https://underautomation.com/fanuc/documentation/get-started-python
+Project-URL: Source, https://github.com/underautomation/Fanuc.py
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: pythonnet==3.0.5
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Fanuc Communication SDK for Python
+
+[![UnderAutomation Fanuc communication SDK](https://raw.githubusercontent.com/underautomation/Fanuc.NET/refs/heads/main/.github/assets/banner.png)](https://underautomation.com)
+
+[![Python](https://img.shields.io/badge/Python-3.5_|_3.6_|_3.7_|_3.8|_3.9_|_3.10_|_3.11_|_3.12_-blue)](#)
+[![Platform](https://img.shields.io/badge/Platform-Windows%20%7C%20Linux%20%7C%20macOS-blue)](#)
+[![License](https://img.shields.io/badge/License-Commercial-red)](https://underautomation.com/fanuc/eula)
+
+### 🤖 Effortlessly Communicate with Fanuc robots
+
+The **Fanuc SDK for Python** enables seamless integration with Fanuc robots for automation, data exchange, and remote control.  
+It supports communication with **real robots** and **ROBOGUIDE**.
+
+🔗 **More Information:** [https://underautomation.com/fanuc](https://underautomation.com/fanuc)  
+🔗 Also available in **[🟦 .NET](https://github.com/underautomation/Fanuc.NET)** & **[🟨 LabVIEW](https://github.com/underautomation/Fanuc.vi)**
+
+---
+
+[⭐ Star this repo if it's useful to you!](https://github.com/underautomation/Fanuc.py/stargazers)  
+[👁️ Watch for updates](https://github.com/underautomation/Fanuc.py/watchers)
+
+---
+
+## 🚀 TL;DR
+
+- ✔️ **No PCDK needed**: Connect without Fanuc’s Robot Interface
+- 📖 **Read/write system variables**
+- 🔄 **Register access for numbers, strings, and positions**
+- 🎬 **Program control (run, pause, abort, etc.)**
+- 🔔 **Alarm viewing and reset**
+- ⚡ **I/O control (UI, UO, GI, GO, etc.)**
+- 🔍 **State & diagnostics monitoring**
+- 📂 **FTP file & variable access**
+
+No additional robot options or installations are required.
+
+---
+
+## 📌 Features
+
+### 🖥️ 1. Telnet KCL Remote Control
+
+Remotely send commands to the robot controller via Telnet KCL.
+
+```python
+robot.telnet.reset()
+robot.telnet.run("MyProgram")
+robot.telnet.pause("MyProgram")
+robot.telnet.hold("MyProgram")
+robot.telnet.continue_("MyProgram")
+robot.telnet.abort("MyProgram", force=True)
+
+robot.telnet.set_variable("my_variable", 42)
+robot.telnet.set_variable("$RMT_MASTER", 1)
+
+robot.telnet.set_port("DOUT", 2, 0)
+robot.telnet.simulate("DIN", 3, 1)
+robot.telnet.unsimulate("DIN", 3)
+```
+
+---
+
+### 🚀 2. High-Speed Data via SNPX (RobotIF)
+
+SNPX provides fast, structured data exchange with the robot.
+
+```python
+# Read/write position registers
+position = robot.snpx.position_registers.read(1)
+robot.snpx.position_registers.write(2, {"x": 100, "y": 50, "z": 25})
+
+# Read/write numeric registers
+value = robot.snpx.registers.read(1)
+robot.snpx.registers.write(2, 123.45)
+
+# Digital signals
+ui_1 = robot.snpx.ui.read(1)
+robot.snpx.uo.write(3, True)
+
+# Alarms & status
+robot.snpx.clear_alarms()
+position = robot.snpx.current_position.read_world_position()
+user_frame = robot.snpx.current_position.read_user_frame_position(1)
+```
+
+---
+
+### 📂 3. FTP File and Variable Management
+
+Transfer files and manage internal robot data via FTP.
+
+```python
+# File transfer
+robot.ftp.direct_file_handling.upload_file_to_controller("C:/Programs/MyPrg.tp", "md:/MyPrg.tp")
+robot.ftp.direct_file_handling.download_file_from_controller("md:/Backup.va", "C:/Backup/Backup.va")
+robot.ftp.direct_file_handling.delete_file("md:/OldProgram.tp")
+
+# Variables
+variables = robot.ftp.get_all_variables()
+for var in variables:
+    print(f"{var.name} = {var.value}")
+
+# System variables
+remote_mode = robot.ftp.known_variable_files.get_system_file().rmt_master
+
+# Safety status
+safety = robot.ftp.get_safety_status()
+print(f"E-Stop: {safety.external_estop}, TP Enabled: {safety.tp_enable}")
+
+# Position
+position = robot.ftp.get_current_position()
+print(f"X={position.cartesian.x}, Y={position.cartesian.y}, Z={position.cartesian.z}")
+```
+
+---
+
+## 🔧 Robot Configuration
+
+### ✅ Enable Telnet KCL
+
+- Go to `SETUP > Host Comm`
+- Select `TELNET` → `[DETAIL]`
+- Set a password and reboot
+
+### ✅ Enable FTP
+
+- Go to `SETUP > Host Comm > FTP`
+- Set username/password
+- Perform a cold start
+
+### ✅ Enable SNPX
+
+- For **FANUC America (R650 FRA)**: Enable option R553 “HMI Device SNPX”
+- For **FANUC Ltd. (R651 FRL)**: No additional options required
+
+---
+
+## 🛠 Installation
+
+### 1️⃣ Clone or Download
+
+This SDK is not on PyPI (yet). Clone this repository and install dependencies :
+
+```bash
+git clone https://github.com/underautomation/Fanuc.py.git
+cd Fanuc.py
+pip install -e .
+```
+
+### 2️⃣ Connect to Your Robot
+
+```python
+from underautomation.fanuc.fanuc_robot import FanucRobot
+from underautomation.fanuc.connection_parameters import ConnectionParameters
+
+robot = FanucRobot()
+robot.connect(ConnectionParameters("192.168.0.1"))
+```
+
+---
+
+## 🔍 Compatibility
+
+✅ **Robot Controllers:** R-J3iB, R-30iA, R-30iB  
+✅ **OS:** Windows, Linux, macOS  
+✅ **Python:** 3.5+
+
+---
+
+## 📢 Contributing
+
+We welcome your feedback and contributions!
+
+- Report issues via [GitHub Issues](https://github.com/underautomation/Fanuc.py/issues)
+- Submit pull requests with enhancements
+- Suggest features and improvements
+
+---
+
+## 📜 License
+
+**⚠️ This SDK requires a commercial license.**  
+🔗 Learn more: [UnderAutomation Licensing](https://underautomation.com/fanuc/eula)
+
+## 📬 Need Help?
+
+- 📖 **Documentation**: [https://underautomation.com/fanuc/documentation](https://underautomation.com/fanuc/documentation)
+- 📩 **Contact Us**: [https://underautomation.com/contact](https://underautomation.com/contact)