OC_Assistant

KO | EN

gitlite — search

#javascript #llm #golang #deep-learning #windows #awesome #cli #kubernetes #awesome-list #vue #security #mcp #ios #open-source

(★ 25)

Open Commissioning Assistant

OC_Assistant Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OC.Assistant
The Open Commissioning Assistant is a portable Desktop Application
to connect external systems via plugins and make the data available to Unity.
Enabling a dotnet environment with full support for dependencies and nuget packages.

### Download links
* [Assistant](https://github.com/OpenCommissioning/OC_Assistant/releases/latest)
* Plugin for [PlcSimAdvanced](https://github.com/OpenCommissioning/OC_Assistant_PlcSimAdvanced/releases/latest)
* Plugin for [OfficeLite](https://github.com/OpenCommissioning/OC_Assistant_OfficeLite/releases/latest)
* Plugin for [RobotStudio](https://github.com/OpenCommissioning/OC_Assistant_RobotStudio/releases/latest)

More plugins available on request (RoboticsSuite, SimitSharedMemory, Modbus ...)

## Requirements
- ``.NET Desktop Runtime 10.0.x``
- Plugins may require additional dependencies

## Plugin System
Plugins enable the Assistant to connect to external systems such as PLCs, Robot controllers and other control data sources, 
making this data available for Unity.

Typical use cases:
- Cyclic communication with PLCs
- Cyclic communication with Robot controllers
- Acyclic data handling

### Installation
1. Create a folder named `Plugins` in the directory of the `OC.Assistant.exe`.
2. Move the unpacked plugin folder into the `Plugins` folder.
3. Start the `OC.Assistant.exe` application.
4. The Assistant will search for `*.plugin` files and load compatible assemblies.

### Usage
1. Create a new instance of a plugin using the `+` button.
2. Configure the plugin instance with required settings.
3. When starting, the plugin variables become available for use in Unity.

## TwinCAT Integration

TwinCAT can be used to act as a co-simulation for simulating behaviour models in realtime and making
device data available for the Unity project.

See [OC.Assistant.Twincat](OC.Assistant.Twincat/README.md)

# Contributing

We welcome contributions from everyone and appreciate your effort to improve this project.
We have some basic rules and guidelines that make the contributing process easier for everyone involved.

## Submitting Pull Requests

1. For non-trivial changes, please open an issue first to discuss your proposed changes.
2. Fork the repo and create your feature branch.
3. Follow the code style conventions and guidelines throughout working on your contribution.
4. Create a pull request with a clear title and description.

After your pull request is reviewed and merged.

> [!NOTE]
> All contributions will be licensed under the project's license.

## Code Style Convention

Please follow these naming conventions in your code:

| Type           | Rule             |
|----------------|------------------|
| Private field  | _lowerCamelCase  |
| Public field   | UpperCamelCase   |
| Protected field | UpperCamelCase  |
| Internal field | UpperCamelCase   |
| Property       | UpperCamelCase   |
| Method         | UpperCamelCase   |
| Class          | UpperCamelCase   |
| Interface      | IUpperCamelCase  |
| Local variable | lowerCamelCase   |
| Parameter      | lowerCamelCase   |
| Constant       | UPPER_SNAKE_CASE |

## Guidelines for Contributions

- **Keep changes focused:** Submit one pull request per bug fix or feature. This makes it easier to review and merge your contributions.
- **Discuss major changes:** For large or complex changes, please open an issue to discuss with maintainers before starting work.
- **Commit message format**: Use the [semantic-release](https://semantic-release.gitbook.io/semantic-release#commit-message-format) commit message format.
- **Write clear code:** Prioritize readability and maintainability.
- **Be consistent:** Follow existing coding styles and patterns in the project.
- **Include tests:** It is recommended to add or update tests to cover your changes.
- **Document your work:** Update relevant documentation, including code comments and user guides.

We appreciate your contributions and look forward to collaborating with you to improve this project!

OC_Assistant

OC_Assistant Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

OC_Assistant

OC_Assistant Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README