lenz-flashtool Documentation

Welcome to lenz-flashtool, a Python library for BiSS C firmware updates and calibration of LENZ Encoders. This guide introduces the library and provides a quick start for new users.

User Guide

• Getting Started
  • What is lenz-flashtool?
  • About LENZ Encoders
  • Quick Start
  • Next Steps
  • Contributing
  • License
  • Contact
• Installation
  • Prerequisites
  • Installation Steps
  • Troubleshooting
• Usage
  • Firmware Update
  • Calibration
  • Zeroing
  • Change the encoder direction sensing
  • Set the encoder resolution to 24 bits

API Reference

• lenz-flashtool Library API Reference
  • BiSSBank
  • FlashTool
  • FlashToolError
  • LenzEncoderProcessor
  • MockFlashTool
  • TermColors
  • UartBootloaderSeq
  • UartCmd
  • biss_send_dif()
  • biss_send_hex()
  • calculate_checksum()
  • connect_and_enter_fw()
  • connect_and_stay_in_bl()
  • dif2hex()
  • generate_hex_line()
  • get_nonce()
  • init_logging()
  • plot()
  • plot2()
  • prep_hex()
  • read_hex_file_irs()
  • send_hex_irs_enc()
• FlashTool Module
  • FlashTool
  • FlashToolError
  • UartBootloaderSeq
  • UartCmd
  • biss_send_dif()
  • biss_send_hex()
  • calculate_checksum()
  • connect_and_enter_fw()
  • connect_and_stay_in_bl()
  • dif2hex()
  • generate_hex_line()
  • get_nonce()
  • init_logging()
  • prep_hex()
  • read_hex_file_irs()
  • send_hex_irs_enc()
• BiSS Module
  • BiSSBank
  • biss_crc6_calc()
  • interpret_biss_commandstate()
  • interpret_error_flags()
• EncProc Module
  • LenzEncoderProcessor
• utils Module
  • TermColors
  • percent_complete()
  • plot()
  • plot2()
• testing Module
  • MockFlashTool
• BiSS CLI Module
  • BiSSCommandLine
  • main()

Indices and tables

• Index

• Module Index

• Search Page