pyx2cscope 0.0.2__tar.gz

pyx2cscope-0.0.2/LICENSE

@@ -0,0 +1,19 @@
+  (c) 2020 Microchip Technology Inc. and its subsidiaries.
+
+  Subject to your compliance with these terms, you may use Microchip software
+  and any derivatives exclusively with Microchip products. You're responsible
+  for complying with 3rd party license terms applicable to your use of 3rd
+  party software (including open source software) that may accompany Microchip
+  software.
+
+  SOFTWARE IS "AS IS." NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY,
+  APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,
+  MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
+
+  IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
+  INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
+  WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP
+  HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO
+  THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL
+  CLAIMS RELATED TO THE SOFTWARE WILL NOT EXCEED AMOUNT OF FEES, IF ANY,
+  YOU PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.

pyx2cscope-0.0.2/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.1
+Name: pyx2cscope
+Version: 0.0.2
+Summary: python implementation of X2Cscope
+Home-page: https://x2cscope.github.io/
+License: Proprietary
+Author: Yash Agarwal
+Author-email: yash.agarwal@microchip.com
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: PyQt5 (>=5.15.9,<6.0.0)
+Requires-Dist: mchplnet (==0.0.2)
+Requires-Dist: numpy (>=1.25.1,<2.0.0)
+Requires-Dist: pyelftools (>=0.29,<0.30)
+Requires-Dist: pyserial (>=3.5,<4.0)
+Project-URL: Documentation, https://x2cscope.github.io/
+Project-URL: Repository, https://github.com/X2Cscope/pyx2cscope
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="docs/img/microchip-technology-logo.png" alt="PyX2CScope Logo" width="250">
+</p>
+
+# PyX2CScope
+- PyX2CScope is the Python implementation of the X2Cscope plugin from MPLABX.
+- This will let the user use the functionality of X2Cscope even outside of mplabx enviroment / Standalone.
+
+## Getting Started
+
+1. You can install the module using pip: <br>`pip install pyx2cscope`
+2. Go to the `Examples` directory in the PyX2CScope project to check out the available examples or create a new .py file according to your requirements.
+3. start with importing PyX2CScope:  `import pyx2cscope`
+4. Choose the communication interface from the interfaces' module. Currently, only Serial is supported: CAN and LIN coming in near future: <br> 
+```
+from mchplnet.interfaces.factory import InterfaceFactory
+from mchplnet.interfaces.factory import InterfaceType as IType
+from mchplnet.lnet import LNet
+``` 
+5. Set up the Serial connection with the desired COM port and baud rate:
+```
+serial_port = "COM9"
+baud_rate = 115200
+interface = InterfaceFactory.get_interface(IType.SERIAL, port = serial_port, baudrate = baud_rate)
+```
+6. Initialize the LNet object with the serial connection:
+```
+l_net = pyx2cscope.LNet(interface)
+```
+7.  Setup the Variable factory.  
+```
+variable_factory = pyx2cscope.VariableFactory(l_net, elf_file)
+```  
+8. Replace the **elf_file** with the path to the ELF file of your project.
+9. Create a Variable object for the variable you want to monitor:
+```
+Variable = variable_factory.get_variable_elf('Variable_name')
+``` 
+10. Replace 'Variable_name' with the name of the variable you want to monitor. You can create multiple variable objects as needed.
+11. Once you have gone through these steps, you can use the get_value() function to retrieve the value of the variable:``Variable.get_value()``. You can also use the ``Variable.set_value(value)`` function to set the value of the variable.
+
+
+## Contribute
+If you discover a bug or have an idea for an improvement, we encourage you to contribute! You can do so by following these steps:
+
+1. Fork the PyX2CScope repository.
+2. Create a new branch for your changes.
+3. Make the necessary changes and commit them. 
+4. Push your changes to your forked repository. 
+5. Open a pull request on the main PyX2CScope repository, describing your changes.
+
+We appreciate your contribution!
+
+
+
+-------------------------------------------------------------------
+
+
+
+

pyx2cscope-0.0.2/README.md

@@ -0,0 +1,59 @@
+<p align="center">
+  <img src="docs/img/microchip-technology-logo.png" alt="PyX2CScope Logo" width="250">
+</p>
+
+# PyX2CScope
+- PyX2CScope is the Python implementation of the X2Cscope plugin from MPLABX.
+- This will let the user use the functionality of X2Cscope even outside of mplabx enviroment / Standalone.
+
+## Getting Started
+
+1. You can install the module using pip: <br>`pip install pyx2cscope`
+2. Go to the `Examples` directory in the PyX2CScope project to check out the available examples or create a new .py file according to your requirements.
+3. start with importing PyX2CScope:  `import pyx2cscope`
+4. Choose the communication interface from the interfaces' module. Currently, only Serial is supported: CAN and LIN coming in near future: <br> 
+```
+from mchplnet.interfaces.factory import InterfaceFactory
+from mchplnet.interfaces.factory import InterfaceType as IType
+from mchplnet.lnet import LNet
+``` 
+5. Set up the Serial connection with the desired COM port and baud rate:
+```
+serial_port = "COM9"
+baud_rate = 115200
+interface = InterfaceFactory.get_interface(IType.SERIAL, port = serial_port, baudrate = baud_rate)
+```
+6. Initialize the LNet object with the serial connection:
+```
+l_net = pyx2cscope.LNet(interface)
+```
+7.  Setup the Variable factory.  
+```
+variable_factory = pyx2cscope.VariableFactory(l_net, elf_file)
+```  
+8. Replace the **elf_file** with the path to the ELF file of your project.
+9. Create a Variable object for the variable you want to monitor:
+```
+Variable = variable_factory.get_variable_elf('Variable_name')
+``` 
+10. Replace 'Variable_name' with the name of the variable you want to monitor. You can create multiple variable objects as needed.
+11. Once you have gone through these steps, you can use the get_value() function to retrieve the value of the variable:``Variable.get_value()``. You can also use the ``Variable.set_value(value)`` function to set the value of the variable.
+
+
+## Contribute
+If you discover a bug or have an idea for an improvement, we encourage you to contribute! You can do so by following these steps:
+
+1. Fork the PyX2CScope repository.
+2. Create a new branch for your changes.
+3. Make the necessary changes and commit them. 
+4. Push your changes to your forked repository. 
+5. Open a pull request on the main PyX2CScope repository, describing your changes.
+
+We appreciate your contribution!
+
+
+
+-------------------------------------------------------------------
+
+
+

pyx2cscope-0.0.2/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "pyx2cscope"
+version = "0.0.2"
+description = "python implementation of X2Cscope"
+authors = [
+  "Yash Agarwal <yash.agarwal@microchip.com>",
+  "Edras Pacola",
+  "Christoph Baumgartner",
+  "Mark Wendler",
+]
+readme = "README.md"
+packages = [{include = "pyx2cscope"}]
+
+license = "Proprietary"
+
+homepage = "https://x2cscope.github.io/"
+documentation = "https://x2cscope.github.io/"
+repository = "https://github.com/X2Cscope/pyx2cscope"
+
+[tool.poetry.dependencies]
+pyserial = "^3.5"
+pyelftools = "^0.29"
+numpy = "^1.25.1"
+PyQt5 = "^5.15.9"
+mchplnet = "0.0.2"
+
+[tool.setuptools.packages.find]
+exclude = ["test", "doc", "examples"]  # empty by default

pyx2cscope-0.0.2/pyx2cscope/__main__.py

@@ -0,0 +1,10 @@
+import sys
+
+from PyQt5.QtWidgets import QApplication
+
+from pyx2cscope.gui.minimal_gui import X2Cscope_GUI
+
+app = QApplication(sys.argv)
+ex = X2Cscope_GUI()
+ex.show()
+app.exec_()