Skip to main content

python implementation of X2Cscope

Project description

PyX2CScope Logo

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:
    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:
from mchplnet.interfaces.factory import InterfaceFactory
from mchplnet.interfaces.factory import InterfaceType as IType
from mchplnet.lnet import LNet
  1. 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)
  1. Initialize the LNet object with the serial connection:
l_net = pyx2cscope.LNet(interface)
  1. Setup the Variable factory.
variable_factory = pyx2cscope.VariableFactory(l_net, elf_file)
  1. Replace the elf_file with the path to the ELF file of your project.
  2. Create a Variable object for the variable you want to monitor:
Variable = variable_factory.get_variable_elf('Variable_name')
  1. Replace 'Variable_name' with the name of the variable you want to monitor. You can create multiple variable objects as needed.
  2. 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!


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyx2cscope-0.0.2.tar.gz (118.7 kB view details)

Uploaded Source

Built Distribution

pyx2cscope-0.0.2-py2.py3-none-any.whl (122.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pyx2cscope-0.0.2.tar.gz.

File metadata

  • Download URL: pyx2cscope-0.0.2.tar.gz
  • Upload date:
  • Size: 118.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Windows/10

File hashes

Hashes for pyx2cscope-0.0.2.tar.gz
Algorithm Hash digest
SHA256 05903e2c247f742df25bcad4b10e829cdb2886f5fac38695c81382215764e9bd
MD5 75efeb0f9e5fe563108b2e08ad02e3ef
BLAKE2b-256 af0fd2f0d149694ae0c5db6d03adf4745b4bbfb4853958a53d9f70bc9d058760

See more details on using hashes here.

Provenance

File details

Details for the file pyx2cscope-0.0.2-py2.py3-none-any.whl.

File metadata

  • Download URL: pyx2cscope-0.0.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 122.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Windows/10

File hashes

Hashes for pyx2cscope-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e27b92d0944cba95728ebc128ead0be9d896b02d10bffb09f37ba236c0d50d65
MD5 a6565a08f95991e98aaf13fb38eb4b25
BLAKE2b-256 0063701406094f82ed6d069981ff0f42ccd576b7d3c919bf6fcd52899cff42ee

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page