foxBMS 2 - 1.9.0 Logo

General Information

  • 1. Releases
  • 2. Changelog
  • 3. Motivation
  • 4. Safety
  • 5. License
  • 6. Team

Introduction

  • 1. Abbreviations and Definitions
  • 2. Naming Conventions
  • 3. The foxBMS 2 Platform
  • 4. Use Case

Getting Started

  • 1. Getting Started with foxBMS 2
  • 2. Repository Structure
  • 3. Software Installation
  • 4. fox CLI
  • 5. Creating a Workspace
  • 6. First Steps on Hardware

Software Documentation

  • 1. Configuration
  • 2. Building the Application
  • 3. Software Structure Overview
  • 4. Software Modules
  • 5. Unit Tests
  • 6. Build Process
  • 7. Build Environment
  • 8. How-to
  • 9. Linker Script
  • 10. Software Architecture
  • 11. Operating System
  • 12. Bootloader

Hardware Documentation

  • 1. Hardware
  • 2. Design Resources
  • 3. Connectors
  • 4. Master Overview
  • 5. Slaves Overview
  • 6. Interfaces Overview

System Documentation

  • 1. System Introduction
  • 2. System Voltage And Current Monitoring
  • 3. Precharging
  • 4. IMD Testing
  • 5. Communication

Tools Documentation

  • 1. fox.py
  • 2. fox.py API
    • 2.1. cli
      • 2.1.1. cli.cli
      • 2.1.2. cli.cmd_axivion
      • 2.1.3. cli.cmd_bms
      • 2.1.4. cli.cmd_bootloader
      • 2.1.5. cli.cmd_build
      • 2.1.6. cli.cmd_ci
      • 2.1.7. cli.cmd_cli_unittest
      • 2.1.8. cli.cmd_embedded_ut
      • 2.1.9. cli.cmd_etl
      • 2.1.10. cli.cmd_ide
      • 2.1.11. cli.cmd_install
      • 2.1.12. cli.cmd_log
      • 2.1.13. cli.cmd_misc
      • 2.1.14. cli.cmd_plot
      • 2.1.15. cli.cmd_pre_commit
      • 2.1.16. cli.cmd_release
      • 2.1.17. cli.cmd_run_program
      • 2.1.18. cli.cmd_run_script
      • 2.1.19. cli.commands
      • 2.1.20. cli.foxbms_version
      • 2.1.21. cli.helpers
        • 2.1.21.1. cli.helpers.TOOL
        • 2.1.21.2. cli.helpers.click_helpers
        • 2.1.21.3. cli.helpers.fcan
        • 2.1.21.4. cli.helpers.host_platform
        • 2.1.21.5. cli.helpers.misc
        • 2.1.21.6. cli.helpers.spr
      • 2.1.22. cli.pre_commit_scripts
  • 3. Waf Tools
  • 4. Debugging the Application
  • 5. HALCoGen tool documentation
  • 6. Axivion Bauhaus Suite

Developer Manual

  • 1. Preface
  • 2. Style Guide
  • 3. Software Developer Manual
  • 4. Hardware Developer Manual
  • 5. fox CLI Implementation
  • 6. Developing fox CLI
  • 7. Dependency Management
  • 8. Release Management

Miscellaneous Information

  • 1. Acknowledgements
  • 2. Indices and Tables
  • 3. Bibliography
foxBMS 2 - 1.9.0
  • 2. fox.py API
  • 2.1. cli
  • 2.1.21. cli.helpers
  • 2.1.21.5. cli.helpers.misc
  • 2.1.21.5.12. cli.helpers.misc.terminal_link_print
  • View page source

2.1.21.5.12. cli.helpers.misc.terminal_link_print

cli.helpers.misc.terminal_link_print(link: Path | str) → str

Prints a clickable link to the terminal :param link: hyperlink that should be clickable

Fork me on GitHub
Previous Next

© Copyright 2010 - 2025, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved. See license section for further information..

Built with Sphinx using a theme provided by Read the Docs.