Difference between revisions of "Talk:BaSyx"

Revision as of 10:06, 25 June 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

User Documentation
- User Tutorials
- Using the BaSyx Docker-Components
  - BaSyx AAS Server Component
  - BaSyx Registry Component
- Integrated end-user applications
  - Dashboard & Live-data analytics
- Releases
  - Releases and releas plans
- Concepts and architecture
- SDK documentation
  - Java
  - Knowledge base

Research
- Ongoing research
- Publications

Glossary
- Glossary and abbreviations

@@ Line 58: / Line 58: @@
 * Overview
 ** [[BaSyx_/_Industrie_4.0 | Industrie 4.0 introduction]]
-** [[BaSyx_/_Overview | BaSyx Industrie 4.0 middleware features]] (where should this go now?; not really mentioned anywhere in new structure -> Suggestion: "Why use BaSyx?")
+** [[BaSyx_/_Overview | Why use BaSyx?]]
 ** [[BaSyx_/_WhatIsBasyx | BaSyx explained]]
 ** [[BaSyx_/_Reference_Users | BaSyx reference applications]]
-** [[BaSyx_/_Offers | BaSyx commercial offers]] (non existent)
+** [[BaSyx_/_Offers | BaSyx commercial offers]]
-** [[BaSyx_/_Articles | BaSyx articles]] (non existent)
+** [[BaSyx_/_Articles | BaSyx articles]]
 * User Documentation
 ** User Tutorials
-*** [[BaSyx_/_Download | Downloading BaSyx]] (not really extensive; Download of containers missing)
+*** [[BaSyx_/_Download | Downloading BaSyx]]
 *** [[BaSyx_/_RelatedDownloads | Related downloads]]
-*** [[BaSyx_/_Setup_Basic_Infrastructure | Setting up a basic infrastructure]] (non existent; currently splitted into multiple articles)
+*** [[BaSyx_/_Setup_Basic_Infrastructure | Setting up a basic infrastructure]]
 ** Using the BaSyx Docker-Components
 *** [[BaSyx_/_Documentation_/_Components_/_AAS_Server | BaSyx AAS Server Component]]
@@ Line 75: / Line 75: @@
 ** Integrated end-user applications
 *** [[BaSyx_/_Documentation_/_Monitoring_Scenarios | Dashboard & Live-data analytics]]
-*** [[BaSyx_/_Controlling | Controlling and events]] (non existent)
 ** Releases
 *** [[BaSyx_/_Releases_and_Features | Releases and releas plans]]
@@ Line 96: / Line 95: @@
 *** Knowledge base
 **** [[BaSyx_/_Introductory_Examples | Introductory Examples]]
-**** [[BaSyx_/_Examples | Extended Examples]] (should the knowledge base section really only contain Extended Examples?)
+**** [[BaSyx_/_Examples | Extended Examples]]
 **** [[BaSyx_/_Scenarios | Documented Application Scenarios]]

Breadcrumbs

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"

Revision as of 10:06, 25 June 2021

BaSyx Middleware Documentation