pykitinfo 1.0.3.15 release on PyPI

microchip-pic-avr-tools · Feb 7, 2024 · 97e0c4b · 97e0c4b
1 parent aeb355b
commit 97e0c4b
Show file tree

Hide file tree

Showing 39 changed files with 1,121 additions and 13,980 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,18 @@
 # Changelog
 
+## [1.0.3] - January 2024
+
+### Added
+- DSG-5792 added brief mode for reporting serial port only
+- DSG-6091 added support for reading out nEDBG extension information
+- DSG-6444 added support for PICkit 5
+
+### Fixed
+- DSG-5767 fixed unicode output in long mode
+- DSG-6310 added fault tolerance for non-numeric interface numbers
+- DSG-7084 fixed crash on Mac when virtual serial port is missing serial number
+- DSG-7087 added fault tolerance for USB devices missing serial number
+
 ## [0.4.0] - November 2022
 
 ### Changed

diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2021 Microchip Technology Inc. and its subsidiaries.
+Copyright (c) 2024 Microchip Technology Inc. and its subsidiaries.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/README.md b/README.md
@@ -14,16 +14,14 @@ Browse source code on [github](https://github.com/microchip-pic-avr-tools/pykiti
 
 Read API documentation on [github](https://microchip-pic-avr-tools.github.io/pykitinfo)
 
-Read the changelog on [github](https://github.com/microchip-pic-avr-tools/pykitinfo/blob/main/CHANGELOG.md)
-
 pykitinfo currently supports:
 - all PKOB nano (nEDBG), mEDBG and EDBG kits
 - Atmel-ICE, Power Debugger, JTAGICE3
-- PICkit4, Snap (AVR mode)
-- PICkit3, PKoB, PICkit4, PKOB4, Snap (PIC mode) - partial support
+- PICkit3, PKOB
+- PICkit4, Snap, PKOB4, PICkit5
 
 ## Usage
-pykitinfo can be used as a library or as a CLI 
+pykitinfo can be used as a library or as a CLI
 
 ### CLI usage
 When installed using pip, pykitinfo CLI is located in the Python scripts folder.
@@ -49,6 +47,33 @@ Kit J50200000000: 'Power Debugger CMSIS-DAP' () on N/A
 Kit ATML2323040200000000: 'mEDBG' (ATmega328P) on COM26
 ```
 
+#### CLI example - simple list of connected kits with specific serial number
+```bash
+pykitinfo -s <serialnumber ending>
+```
+Displays a simple list of kits in the form:
+Kit SERIAL-NUMBER: 'KIT-NAME' (DEVICE-NAME) on SERIAL-PORT
+
+For example:
+```bash
+pykitinfo -s 29
+Looking for Microchip kits...
+Compatible kits detected: 1
+Kit MCHP3352011800000029: 'PIC-IoT WA' (PIC24FJ128GA705) on COM22
+```
+
+#### CLI example - brief lookup of serial port of connected kit
+```bash
+pykitinfo -b
+```
+Displays ONLY the serial port name of a connected kit.  This can be useful for command chaining.
+
+For example:
+```bash
+pykitinfo -b -s 123456
+COM12
+```
+
 #### CLI example - long form list of connected kits
 ```bash
 pykitinfo -l

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'pykitinfo'
-copyright = '2021, Microchip Technology Inc'
+copyright = '2024, Microchip Technology Inc'
 author = 'Microchip Technology Inc'
 
 

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: bc5e93d2a89e0af5b8ee17ad7615db0c
+config: 146cff4dc62d995e074bf9e996667a30
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_static/_sphinx_javascript_frameworks_compat.js b/docs/_static/_sphinx_javascript_frameworks_compat.js
diff --git a/docs/_static/basic.css b/docs/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -324,13 +324,15 @@ aside.sidebar {
 p.sidebar-title {
     font-weight: bold;
 }
+
 nav.contents,
 aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
+
 nav.contents,
 aside.topic,
 div.topic {
@@ -606,6 +608,7 @@ ol.simple p,
 ul.simple p {
     margin-bottom: 0;
 }
+
 aside.footnote > span,
 div.citation > span {
     float: left;
@@ -667,6 +670,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -735,6 +748,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Base JavaScript utilities for all Sphinx HTML documentation.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */