Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Talk:BaSyx"
Line 50: | Line 50: | ||
Glossary | Glossary | ||
+ | |||
+ | |||
+ | == BaSyx Middleware Documentation == | ||
+ | |||
+ | The documentation of the Eclipse BaSyx middleware is split into the following sub sections: | ||
+ | |||
+ | * Overview | ||
+ | ** [[BaSyx_/_Industrie_4.0 | Industrie 4.0 intorduction]] | ||
+ | ** [[BaSyx_/_Overview | BaSyx Industrie 4.0 middleware features]] (Where should this go now?) | ||
+ | ** [[BaSyx_/_WhatIsBasyx | BaSyx explained]] | ||
+ | ** [[BaSyx_/_Reference_Users | BaSyx reference applications]] | ||
+ | ** [[BaSyx_/_Offers | BaSyx commercial offers]] (non existent) | ||
+ | * User Documentation | ||
+ | ** Using the BaSyx Docker-Components | ||
+ | *** [[BaSyx_/_Documentation_/_Components_/_AAS_Server | BaSyx AAS Server Component]] | ||
+ | *** [[BaSyx_/_Documentation_/_Components_/_Registry | BaSyx Registry Component]] | ||
+ | <!---#*** [[BaSyx CFG sub model provider| Sub Model provider based on static configuration files]] | ||
+ | *** [[BaSyx RAW AAS/Submodel provider| Sub Model provider that provides objects to the Virtual Automation bus]] | ||
+ | *** [[BaSyx SQL Submodel provider| Sub Model provider based on SQL database]] | ||
+ | *** [[BaSyx XQuery Submodel provider| Sub Model provider based on XQuery queries]]---> | ||
+ | ** [[BaSyx_/_Documentation_/_Monitoring_Scenarios | Predefined Monitoring Scenarios]] | ||
+ | |||
+ | * Developer Documentation | ||
+ | ** Concepts and Architecture | ||
+ | *** [[BaSyx_/_Concepts | BaSyx concepts]] | ||
+ | *** [[BaSyx_/_Documentation_/_AssetAdministrationShell | BaSyx Asset Administration Shells (AAS)]] | ||
+ | *** [[BaSyx_/_Documentation_/_API_/_Submodel | BaSyx Asset Administration Shell Sub Models]] | ||
+ | *** [[BaSyx_/_Documentation_/_Registry | BaSyx AAS registry]] | ||
+ | *** [[BaSyx_/_Documentation_/_Identification| BaSyx URI ID schema]] | ||
+ | *** [[BaSyx_/_Documentation_/_SOP | BaSyx Service Oriented Production Approach]] | ||
+ | *** [[BaSyx_/_Documentation_/_ControlComponent|BaSyx Control component]] | ||
+ | *** [[BaSyx_/_Documentation_/_Gateway |BaSyx Virtual Automation Bus Gateway]] | ||
+ | *** [[BaSyx_/_Documentation_/_VAB|BaSyx Virtual Automation Bus]] | ||
+ | *** [[BaSyx Device integration|BaSyx device integration]] | ||
+ | ** Downloading Eclipse BaSyx and related software components | ||
+ | *** [[BaSyx_/_Releases_and_Features | Releases and Features]] | ||
+ | *** [[BaSyx_/_Download | Download & Setup of BaSyx]] | ||
+ | *** [[BaSyx_/_RelatedDownloads | Related downloads]] | ||
+ | ** Developer examples and resources | ||
+ | *** [[BaSyx_/_Introductory_Examples | Introductory Examples]] | ||
+ | *** [[BaSyx_/_Examples | Extended Examples]] | ||
+ | *** [[BaSyx_/_Scenarios | Documented Application Scenarios]] | ||
+ | *** [[BaSyx_/_Developer_/_Contributing | How to contribute and check conformity of new components]] | ||
+ | ** BaSyx SDK documentation - Develop new BaSyx components, device integrations, connections, and applications | ||
+ | *** Java SDK | ||
+ | **** [[BaSyx_/_Documentation_/_SDK_/_Java | Java SDK overview]] | ||
+ | **** [[BaSyx_/_Documentation_/_VAB_Providers_| Java SDK VAB provider overview]] | ||
+ | **** [[BaSyx_/_Developer_/_Extensions_/_Eventing | Java SDK Eventing for AAS]] | ||
+ | * Resources for Researchers | ||
+ | **[[BaSyx_/_Research | Ongoing research]] | ||
+ | **[[BaSyx_/_Publications| Publications]] | ||
+ | * Glossary and background information | ||
+ | **[[BaSyx_/_Glossary | Glossary and abbreviations]] |
Revision as of 06:07, 5 May 2021
Structure proposal:
Overview - Introduce Industry 4.0 - BaSyx explained (sufficient knowledge to understand next chapter) - BaSyx reference applications (Partner use-cases & architecture blueprints / documentation) - BaSyx commercial offers - BaSyx articles
User Documentation - User Tutorials
- Downloading BaSyx (Container and tools (-> AASX explorer) etc.) - Setting-up a basic BaSyx infrastructure (Getting container, Setting up Docker, Registry, AAS Server, Configure a static AAS&sub model)
- Using the BaSyx Docker-Components
- BaSyx AAS Server Component - BaSyx Registry Component
- Integrated end-user applications
- Dashboard - Live-data analytics - Controlling and events
Developer Documentation - Developer Tutorials
- Obtaining the BaSyx SDK and developer resources (incl. related downloads) - Setting up a digital production with Eclipse BaSyx - Eclipse BaSyx conformance check for new components - Contributing to Eclipse BaSyx
- Releases and release plans - Concepts and architecture
- BaSyx concepts - BaSyx Asset Administration Shells (AAS) - BaSyx Asset Administration Shell Sub Models - BaSyx AAS registry - BaSyx URI ID schema - BaSyx Service Oriented Production Approach - BaSyx Control component - BaSyx Virtual Automation Bus Gateway - BaSyx Virtual Automation Bus - BaSyx device integration
- SDK documentation
- Java - Java SDK overview - Java SDK VAB provider overview - Java SDK Eventing for AAS
- Knowledge base
- Extended examples -> Split possibly into multiple pages
Research
- Verweis auf Research-Paper
Glossary
BaSyx Middleware Documentation
The documentation of the Eclipse BaSyx middleware is split into the following sub sections:
- Overview
- Industrie 4.0 intorduction
- BaSyx Industrie 4.0 middleware features (Where should this go now?)
- BaSyx explained
- BaSyx reference applications
- BaSyx commercial offers (non existent)
- User Documentation
- Using the BaSyx Docker-Components
- Predefined Monitoring Scenarios
- Developer Documentation
- Concepts and Architecture
- Downloading Eclipse BaSyx and related software components
- Developer examples and resources
- BaSyx SDK documentation - Develop new BaSyx components, device integrations, connections, and applications
- Resources for Researchers
- Glossary and background information