foxBMS 2 - 1.11.0 Logo

Introduction

  • 1. Motivation
  • 2. Naming Conventions
  • 3. The foxBMS 2 Platform
  • 4. Use Case

Getting Started

  • 1. Repository Structure
  • 2. Software Installation
  • 3. fox CLI Basics
  • 4. Creating a Workspace
  • 5. First Steps on Hardware

Software Documentation

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

Hardware Documentation

  • 1. Hardware
  • 2. Design Resources
  • 3. Connectors
  • 4. BMS-Masters Overview
  • 5. BMS-Slaves Overview
  • 6. BMS-Interfaces Overview

System Documentation

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

Tools Documentation

  • 1. fox CLI Usage
  • 2. Waf Tools
  • 3. Debugging the Application
  • 4. TI HALCoGen Tool

Developer Manual

  • 1. Preface
  • 2. Style Guide
  • 3. Software Developer Manual
  • 4. Hardware Developer Manual
  • 5. Developing fox CLI
    • 5.1. fox CLI Implementation
    • 5.2. Extending fox CLI
    • 5.3. fox CLI API
      • 5.3.1. cli
        • 5.3.1.1. cli.cli
        • 5.3.1.2. cli.cmd_bms
        • 5.3.1.3. cli.cmd_bootloader
        • 5.3.1.4. cli.cmd_build
        • 5.3.1.5. cli.cmd_cli_unittest
        • 5.3.1.6. cli.cmd_com
        • 5.3.1.7. cli.cmd_db
        • 5.3.1.8. cli.cmd_embedded_ut
        • 5.3.1.9. cli.cmd_etl
        • 5.3.1.10. cli.cmd_gui
        • 5.3.1.11. cli.cmd_ide
        • 5.3.1.12. cli.cmd_install
        • 5.3.1.13. cli.cmd_log
        • 5.3.1.14. cli.cmd_misc
        • 5.3.1.15. cli.cmd_plot
        • 5.3.1.16. cli.cmd_pre_commit
        • 5.3.1.17. cli.cmd_release
        • 5.3.1.18. cli.cmd_run_program
        • 5.3.1.19. cli.cmd_run_script
        • 5.3.1.20. cli.com
        • 5.3.1.21. cli.commands
        • 5.3.1.22. cli.db
        • 5.3.1.23. cli.foxbms_version
        • 5.3.1.24. cli.helpers
        • 5.3.1.25. cli.pre_commit_scripts
  • 6. Dependency Management
  • 7. Release Management

General Information

  • 1. License
  • 2. Changelog
  • 3. Releases
  • 4. Safety
  • 5. Abbreviations and Definitions
  • 6. Acknowledgements
  • 7. Bibliography
  • 8. Team
foxBMS 2 - 1.11.0
  • 5. Developing fox CLI
  • 5.3. fox CLI API
  • 5.3.1. cli
  • 5.3.1.24. cli.helpers
  • 5.3.1.24.13. cli.helpers.misc
  • 5.3.1.24.13.11. cli.helpers.misc.terminal_link_print
  • View page source

5.3.1.24.13.11. cli.helpers.misc.terminal_link_print

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

Create a clickable hyperlink string for terminal output.

Parameters:

link – Hyperlink to be printed.

Returns:

Clickable terminal hyperlink.

Fork me on GitHub
Previous Next

© Copyright 2010 - 2026, 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.