semvec/pypi-packages huggingface dataset:
spmtool 1.0.0
Read/write SPM motor controller configuration over serial connection
License: MIT
Requires Python: >=3.9
Keywords: serial, spm, kelly

# spmtool

Read/write Kelly SPM brushed motor controller
configuration over serial connection. Tested with:

   - SPM24121


## Usage

Test serial connection:

	$ spmtool

Show help:

	$ spmtool -h
	usage: spmtool [-h] [-r | -w | -c] [-v] [-d DEVICE] [-s SETTINGS] [file]
	
	positional arguments:
	  file           config file
	
	options:
	  -h, --help     show this help message and exit
	  -r, --read     read controller memory to file
	  -w, --write    write config to controller
	  -c, --check    check and compare controller config
	  -v, --verbose  show debug log
	  -d DEVICE      serial port device
	  -s SETTINGS    settings schema preset or file


### Read Memory

Connect to controller, read memory, optionally mask settings
and then save to nominated file.

Read controller settings into conf.bin using SPM24121 preset:

	$ spmtool -r -s SPM24121 conf.bin


### Write Memory

Load config from nominated file, connect to controller,
update any settings listed in settings schema
on controller and save. A settings schema file or preset is
mandatory in this mode, see "Settings Schema" below for details.

Write settings from conf.bin to controller using SPM24121 preset:

	$ spmtool -w -s SPM24121 conf.bin


### Check Memory

Load config file, connect to controller and then list any differences
between config and controller memory. Optionally mask config and
memory with a settings schema.

Compare controller memory with contents of conf.bin using SPM24121 preset:

	$ spmtool -c -s SPM24121 conf.bin


## Settings Schema

Controller settings are listed in the settings schema
one per line with the whitespace delimited
columns:

	offset mask description

Where offset is a hexadecimal byte offset in the memory,
mask limits the bits that are set/cleared and description
is a text description for the setting. See included file
SPM24121.txt for an example.

To use a defined preset, use preset name as the schema, eg:

	$ spmtool -s SPM24121


## Installation

Install with pip, or run script file directly:

	$ python3 spmtool.py
SiEPIC-TestCreator 0.1.21
A tool for creating YAML files for use in Dream Photonics and edx course
License: MIT
Requires Python: >=3.10

# Project Title

This package is for use in the UBC Photonics courses, and contains utilities for creating
yaml files which act as guides for tests on the probe stations throughout UBC.

## Description

This software contains a User Interface that easily allows users to create custom YAML files to guide tests on probe stations throughout UBC. It is built using PyQt and leverages the dreamcreator and sequencecreator modules for functionality. To add a new stage setup simply add an additional folder in the sequences directory and populate with formatted sequence files, then reload the UI.

## Getting Started

### Dependencies

* Describe any prerequisites, libraries, OS version, etc., needed before installing program.
* ex. Windows 10
python: 3.10 +
Windows 10 or greater, Linux, or Mac OSX


### Installing

```
pip install SiEPIC_TestCreator
```

### Executing program

* How to run the program, note imports are case sensitive
```
from SiEPIC_TestCreator import sequencecreator as sc
sc.launch()
```

## Help

Any advise for common problems or issues.
```
command to run if program contains helper info
```

## Authors

Contributors names and contact info

Jon Barnes [@JonBarnes](https://twitter.com/JonBarnes)

## Version History

* 0.2
    * Various bug fixes and optimizations
    * See [commit change]() or See [release history]()
* 0.1
    * Initial Release

## License

This project is licensed under the MIT License - see the LICENSE.md file for details

## Acknowledgments

Inspiration, code snippets, etc.
* [awesome-readme](https://github.com/matiassingers/awesome-readme)
* [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
* [dbader](https://github.com/dbader/readme-template)
* [zenorocha](https://gist.github.com/zenorocha/4526327)
* [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46)

## Developers

* Contributions are welcome, via Pull Requests
* Create a fork, and download it using GitHub Desktop to work on your local copy
* Install the package as a symbolic link 
    ```
    pip install -e $HOME/Documents/GitHub/SiEPIC_testcreator
    ```
* Keep your fork and local copy up to date