# BaSyx Wiki

Eclipse BaSyx is the open source platform for next generation automation.
Our mission is to provide a free software platform that enables all interested parties, large and small industries, research institutes, academia, and interested persons, to participate and to shape the fourth industrial revolution.
We believe that the availability of a free reference technology platform is a key success factor for the Industrie 4.0.
Eclipse BaSyx therefore provides common and re-useable Industrie 4.0 components and an SDK that supports the development of new Industrie 4.0 software components to enable the rapid development of Industrie 4.0 solutions.
This Eclipse BaSyx platform furthermore will provide reference application scenarios for common Industrie 4.0 challenges.
Eclipse BaSyx is actively supported by the BaSys 4.0 ([Homepage, in German](https://www.basys40.de/)) research project, which is funded by the German Ministry for Education and Research (BMBF, grant no. 01IS16022).
BaSys 4.0 researches and specifies key concepts of Industrie 4.0, participates in standardization activities, and integrates existing standards and technologies into an Industrie 4.0 middleware.

```{figure} ./images/450px-Basyx.video.png
---
figclass: margin
alt: About BaSyx and Industrie 4.0
name: basyx_video
---
[About BaSyx and Industrie 4.0 (video)](https://www.youtube.com/watch?v=kx2F5E5foLU)
```

```{figure} ./images/450px-Basyx.explanation.video.png
---
figclass: margin
alt: Eclipse BaSyx middleware explained
name: basyx_explanation_video
---
[Eclipse BaSyx middleware explained (video)](https://www.youtube.com/watch?v=bMY8FLhjjRI)
```

The Eclipse BaSyx middleware implements main Industrie 4.0 concepts and provides the necessary software components to implement numerous Industrie 4.0 applications:

- End-to-end digitisation of the production (the shopfloor)
- End-to-end connectivity between shopfloor and IT
- Peer-to-peer communication between devices and the IT
- Digital process models, value streams, and product tracking
- Changeable production processes up to lot size one production
- [Digital twins](https://www.iese.fraunhofer.de/en/services/digital-twin.html) for processes, products, devices, and more
- Big data analysis of production processes
- Pre-configured containers for Industrie 4.0 applications, e.g. predictive maintenance, in-process analysis, and dashboards
- Automated tracing and documentation of production processes

Application examples that document the application of Eclipse BaSyx are provided in section [BaSyx application scenarios](https://wiki.eclipse.org/BaSyx_/_Scenarios).

## BaSyx Middleware Documentation

The documentation of the Eclipse BaSyx middleware is split into the following sub sections:

### Introduction

This section will give you a brief overview of Industrie 4.0 and the Eclipse BaSyx middleware.
It also contains a quick start guide that will help you to get started with Eclipse BaSyx.

* [Industrie 4.0](./content/introduction/industrie4.0_intro.md)
* [Why use BaSyx?](./content/introduction/why_basyx.md)
* [BaSyx explained](./content/introduction/basyx_explained.md)
* [Quick Start Guide](./content/introduction/quickstart.md)
* [Contributing](./content/introduction/contributing.md)

```{toctree}
:hidden:
:maxdepth: 1
:caption: Introduction

content/introduction/industrie4.0_intro
content/introduction/why_basyx
content/introduction/basyx_explained
content/introduction/quickstart
content/introduction/contributing
```

### User Documentation

This section contains the user documentation of the Eclipse BaSyx middleware.

* [User Tutorials](./content/user_documentation/user_tutorials/index.md)
* [BaSyx Components](./content/user_documentation/basyx_components/index.md)
* [Integrated End-User Applications](./content/user_documentation/integrated%20end-user%20applications/monitoring_scenarios.md)
* [Releases](./content/user_documentation/releases/releases_and_features.md)
* [Specifications and Architecture](./content/user_documentation/concepts%20and%20architecture/index.md)

```{toctree}
:hidden:
:maxdepth: 1
:caption: User Documentation

content/user_documentation/user_tutorials/index
content/user_documentation/basyx_components/index
content/user_documentation/integrated end-user applications/monitoring_scenarios
content/user_documentation/releases/releases_and_features
content/user_documentation/concepts and architecture/index
content/user_documentation/metamodel/index
```

### Developer Documentation

* [Contributing](./content/developer_documentation/contributing.md)
* [BaSyx Java Version 1](./content/developer_documentation/basyx_java_v1/index.md)
* [BaSyx Java Version 2](./content/developer_documentation/basyx_java_v2/index.md)
* [BaSyx Python SDK](./content/developer_documentation/basyx_python_sdk/index.md)
* [BaSyx AAS Web UI](./content/developer_documentation/basyx_web_ui/index.md)

```{toctree}
:hidden:
:maxdepth: 1
:caption: Developer Documentation

content/developer_documentation/contributing
content/developer_documentation/basyx_java_v1/index
content/developer_documentation/basyx_java_v2/index
content/developer_documentation/basyx_python_sdk/index
content/developer_documentation/basyx_web_ui/index

```

### Concepts

* [BaSyx Concepts](./content/concepts/basyx_concepts.md)
* [Conformity and Consistency](./content/concepts/conformity_and_consistency/index.md)
* [Use Cases](./content/concepts/use_cases/index.md)

```{toctree}
:hidden:
:maxdepth: 1
:caption: Concepts

content/concepts/basyx_concepts
content/concepts/conformity_and_consistency/index
content/concepts/use_cases/index
```