How to

Following pages provide all information necessary to use, develop and contribute to the CosmOS open source project.

• Setup reference project
  • Visual Studio Code
    • Development environment setup
      • Prerequisites
      • First time code checkout
    • Compiling
      • Compiling of the reference project
    • Debugging
    • Logger
      • Prerequisites
  • STM32 Cube IDE
    • Import
      • Prerequisites
      • First time STM32 Cube IDE project import
    • Compiling
      • Prerequisites
      • Compiling of the reference project
    • Debugging
      • Prerequisites
      • STM32 Cube IDE multi-core debugging
      • References
    • Logger
      • Prerequisites
      • New serial port connection creation
  • Configuration
    • Environment and file generation config files
      • Environment config
        • Placeholders
      • File generation config
        • Description of config file structure
          • templates
          • outputDir
          • fileName
          • pattern
          • loop
          • target
    • Generic json file structure
      • Top level json keys
        • Metadata
          • version
        • Attribute properties
          • attributes
            • Properties in an attribute element
              • inherit
              • label
              • tooltip
              • type
              • min
              • max
              • step
              • elements
              • validation
              • hidden
              • placeholder
        • Element properties
          • elements
            • Properties in an elements element
              • target
              • targetNameOverwrite
              • value
              • enabled
  • TCP Echo
    • Prerequisites
    • TCP echo test between windows host and reference hardware
• Use CosmOS in your project
  • Integration
  • Application
  • Supported hardware
• Contribute
  • C
    • Functional
      • Example module folder structure creation
      • Naming conventions
      • Implementation
      • Tips and tricks
    • Tests
      • Example test folder structure creation in module folder
      • Naming conventions
      • Implementation
      • Tips and tricks
    • Run tests
      • How to get the results and tests coverage
        • Console output
        • Generated result XML files
        • Generated coverage HTML page
  • Python
    • Functional
      • Folder structure
      • Naming conventions and code styling
    • Tests
      • Test folder structure in a module folder
      • Naming conventions
      • Implementation
      • Tips and tricks
    • Run tests
      • How to get the results and tests coverage
        • Console output
        • Generated result XML files
        • Generated coverage HTML page
  • Continuous integration
  • What does the Code of Conduct mean for me?
  • Few tips for the newcomers
  • What do I need to know to help?
• Report a bug
  • How to create an issue?
  • List of items that should be included in the bug report
  • Title
  • Environment
  • Steps to Reproduce
  • Expected Result
  • Actual Result
  • Proof
  • Severity/Priority
  • Resources