Metadata-Version: 2.4
Name: canoe-robot-lib
Version: 0.5
Summary: Robot Framework library for CANoe automation
Home-page: https://github.com/Nik-coder789/canoe-robot-lib
Author: Naresh Kothari
Project-URL: Homepage, https://github.com/Nik-coder789/canoe-robot-lib
Project-URL: Repository, https://github.com/Nik-coder789/canoe-robot-lib
Keywords: canoe,robot framework,automation,automotive
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: robotframework
Requires-Dist: py_canoe
Requires-Dist: cantools
Dynamic: author
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# 🚗 CANoe Robot Framework Library

A custom Robot Framework library for automating CANoe using Python.

This library provides reusable keywords to control CANoe, interact with CAN signals, perform diagnostics, manage replay blocks, handle environment/system variables, and execute test modules.

---

## 🔥 Features

* CANoe automation using Robot Framework
* Signal read/write support
* Diagnostic request handling (UDS)
* Replay block control
* Environment & System variable handling
* Test module execution

---

## 📦 Installation

```bash
pip install canoe-robot-lib
```

---

## ⚙️ Requirements

* Python 3.7+
* Robot Framework
* py_canoe library
* CANoe installed (Vector tool)
* Valid CANoe license

---

## 📂 Usage

Import the library in your Robot Framework test file:

```robot
*** Settings ***
Library    canoe_robot_lib.keywords.CanoeLibrary
```

---

## 🧪 Example Test Case

```robot
*** Variables ***
${cfg}    path_to_cfg_file.cfg

*** Test Cases ***
Basic CANoe Test
    Start CANoe    ${cfg}
    Set Signal     CAN    1    Msg    Signal    1
    ${val}=        Get Signal    CAN    1    Msg    Signal
    Should Be Equal As Numbers    ${val}    1
    Stop CANoe
```

---

## 📘 Keywords Documentation

Detailed keyword descriptions are available in:

➡️ [KEYWORDS.md](./KEYWORDS.md)

---

## 📌 Notes

* CANoe configuration (.cfg) must be valid before execution
* User should have knowledge of CANoe setup (signals, DBC, test modules)
* Boolean inputs (True/False) are used for control keywords like replay
* Some features depend on CANoe configuration setup

---

## 👨‍💻 Author

**Naresh Kothari**
System Test Engineer – Automotive Domain

---

## 🚀 Future Enhancements

* Wait For Signal keyword
* Logging block support
* BLF replay validation
* Advanced reporting integration

---

## 📄 License

This project is licensed under the MIT License.
