xtalx
=====
This package provides a library for interfacing with the XtalX pressure and
density/viscosity sensors. Python version 3 is required. The easiest way to
install the xtalx module is using pip::
python3 -m pip install xtalx
Note that you may wish to use sudo to install xtalx for all users on your
system::
sudo python3 -m pip install xtalx
You may also install the package from the source using::
make install
or::
sudo make install
xtalx_p_discover
================
The xtalx package includes the xtalx_p_discover binary which can be used to
list all XtalX pressure sensors that are attached to the system and their
corresponding firmware versions::
~$ xtalx_p_discover
******************
Sensor SN: XTI-7-1000035
git SHA1: 61be0469c1162b755d02fd9156a2754bebf24f59.dirty
Version: 0x0107
xtalx_p_test
============
The xtalx package includes a simple test binary that will connect to an XtalX
pressure sensor and continuously print the current pressure and temperature
reading::
~$ xtalx_p_test
XtalX(XTI-7-1000035): 23.973375 PSI, 23.947930 C
XtalX(XTI-7-1000035): 23.973375 PSI, 23.947930 C
XtalX(XTI-7-1000035): 23.973375 PSI, 23.947930 C
XtalX(XTI-7-1000035): 23.963872 PSI, 23.947930 C
XtalX(XTI-7-1000035): 23.963872 PSI, 23.947930 C
XtalX(XTI-7-1000035): 23.954370 PSI, 23.947930 C
XtalX(XTI-7-1000035): 23.954370 PSI, 23.947930 C
XtalX(XTI-7-1000035): 23.973375 PSI, 23.947930 C
...
Terminate the program by pressing Ctrl-C.
xtalx_z_discover
================
The xtalx packages includes the xtalx_z_discover binary which can be used to
list all XtalX density/viscosity sensors that are attached to the system and
their corresponding firmware version::
~% xtalx_z_discover
******************
Product: XtalX TCSC
Sensor SN: TCSC-1-2000045
git SHA1: b50b8e4a406f0b8585f50c1f9aa7c95145d4810d
Version: 0x0101
xtalx_z_get_info
================
The xtalx package includes the xtalx_z_get_info binary that can be used to get
a bit more detailed information about a sensor::
~% xtalx_z_get_info
[1691531122175214000] I: Controlling sensor TCSC-1-2000045 with firmware 0x101 (b50b8e4a406f0b8585f50c1f9aa7c95145d4810d).
*************************************
Serial Num: TCSC-1-2000045
Git SHA1: b50b8e4a406f0b8585f50c1f9aa7c95145d4810d
FW Version: 0x0101
HCLK: 80000000
DCLK: 2500000
ACLK: 1250000
HSE: 10 MHz
Max cmd len: 16384
# resets: 1
Drive Type: DriveType.INTERNAL_DRIVE
Reset Reason: ResetReason.POWER_ON_RESET
Reset CSR: 0x0C004400
Reset SR1: 0x00000000
Max sweep freqs: 1024
-----------------------
Electrical calibration:
Calibration Date: 1683682186 (Tue May 9 19:29:46 2023)
R Source: 10037.000000
R Feedback: 149850.000000
DAC-to-V: 2.208075 + -0.000256*x
ADC-to-V: 1.674066 + 0.000204*x
Nominal VDDA: 3.35
-----------------------
Tuning fork calibration:
Calibration Date: 1683682197 (Tue May 9 19:29:57 2023)
Cal DAC Amplitude: 975 (0.25V)
xtalx_z_gl_track_mode
=====================
The xtalx package includes the xtalx_z_gl_track_mode binary that is the core
tool for use with the density/viscosity sensor. It features a GUI instead of
command-line output. To execute it::
~% xtalx_z_gl_track_mode
xtalx_z_cli_track_mode
======================
The xtalx package includes the xtalx_z_cli_track_mode binary that is similar
to the GUI track mode tool but only prints log messages to the console and
write measurements to the .csv files. This allows it to be run on a headless
system. To execute it::
~% xtalx_z_cli_track_mode
Windows use
===========
On Windows, the binaries are all launched via the command line just like on
Linux and macOS, however Windows can't automatically find them. In order to
launch them, you need to execute them using their full Python path as follows::
python3 -m xtalx.tools.p_sensor.discover
python3 -m xtalx.tools.p_sensor.xtalx_test_yield
python3 -m xtalx.tools.z_sensor.discover
python3 -m xtalx.tools.z_sensor.get_info
python3 -m xtalx.tools.z_sensor.gl_track_mode
On Windows, it is also common to have the Python interpreter installed under
the name "py" or "py3", so if "python3" does not work for you it is recommended
to try one of the shorter command names. If the Python interpreter cannot be
found, it may not be installed at all so should be installed via the Microsoft
Store (it is a free, open-source install).
Raw data
{
"_id": null,
"home_page": "https://github.com/phasesensors/xtalx_python",
"name": "xtalx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "xtalx",
"author": "Phase Advanced Sensor Systems Corp.",
"author_email": "tgreeniaus@phasesensors.com",
"download_url": "https://files.pythonhosted.org/packages/e1/c9/ba83c11483109ba982a0e09b3d1cb8a6a83e5b264292e780c5c157beeb5b/xtalx-1.2.8.tar.gz",
"platform": null,
"description": "xtalx\n=====\nThis package provides a library for interfacing with the XtalX pressure and\ndensity/viscosity sensors. Python version 3 is required. The easiest way to\ninstall the xtalx module is using pip::\n\n python3 -m pip install xtalx\n\nNote that you may wish to use sudo to install xtalx for all users on your\nsystem::\n\n sudo python3 -m pip install xtalx\n\nYou may also install the package from the source using::\n\n make install\n\nor::\n\n sudo make install\n\n\nxtalx_p_discover\n================\nThe xtalx package includes the xtalx_p_discover binary which can be used to\nlist all XtalX pressure sensors that are attached to the system and their\ncorresponding firmware versions::\n\n ~$ xtalx_p_discover\n ******************\n Sensor SN: XTI-7-1000035\n git SHA1: 61be0469c1162b755d02fd9156a2754bebf24f59.dirty\n Version: 0x0107\n\n\nxtalx_p_test\n============\nThe xtalx package includes a simple test binary that will connect to an XtalX\npressure sensor and continuously print the current pressure and temperature\nreading::\n\n ~$ xtalx_p_test\n XtalX(XTI-7-1000035): 23.973375 PSI, 23.947930 C\n XtalX(XTI-7-1000035): 23.973375 PSI, 23.947930 C\n XtalX(XTI-7-1000035): 23.973375 PSI, 23.947930 C\n XtalX(XTI-7-1000035): 23.963872 PSI, 23.947930 C\n XtalX(XTI-7-1000035): 23.963872 PSI, 23.947930 C\n XtalX(XTI-7-1000035): 23.954370 PSI, 23.947930 C\n XtalX(XTI-7-1000035): 23.954370 PSI, 23.947930 C\n XtalX(XTI-7-1000035): 23.973375 PSI, 23.947930 C\n ...\n\nTerminate the program by pressing Ctrl-C.\n\n\nxtalx_z_discover\n================\nThe xtalx packages includes the xtalx_z_discover binary which can be used to\nlist all XtalX density/viscosity sensors that are attached to the system and\ntheir corresponding firmware version::\n\n ~% xtalx_z_discover\n ******************\n Product: XtalX TCSC\n Sensor SN: TCSC-1-2000045\n git SHA1: b50b8e4a406f0b8585f50c1f9aa7c95145d4810d\n Version: 0x0101\n\n\nxtalx_z_get_info\n================\nThe xtalx package includes the xtalx_z_get_info binary that can be used to get\na bit more detailed information about a sensor::\n\n ~% xtalx_z_get_info\n [1691531122175214000] I: Controlling sensor TCSC-1-2000045 with firmware 0x101 (b50b8e4a406f0b8585f50c1f9aa7c95145d4810d).\n *************************************\n Serial Num: TCSC-1-2000045\n Git SHA1: b50b8e4a406f0b8585f50c1f9aa7c95145d4810d\n FW Version: 0x0101\n HCLK: 80000000\n DCLK: 2500000\n ACLK: 1250000\n HSE: 10 MHz\n Max cmd len: 16384\n # resets: 1\n Drive Type: DriveType.INTERNAL_DRIVE\n Reset Reason: ResetReason.POWER_ON_RESET\n Reset CSR: 0x0C004400\n Reset SR1: 0x00000000\n Max sweep freqs: 1024\n -----------------------\n Electrical calibration:\n Calibration Date: 1683682186 (Tue May 9 19:29:46 2023)\n R Source: 10037.000000\n R Feedback: 149850.000000\n DAC-to-V: 2.208075 + -0.000256*x\n ADC-to-V: 1.674066 + 0.000204*x\n Nominal VDDA: 3.35\n -----------------------\n Tuning fork calibration:\n Calibration Date: 1683682197 (Tue May 9 19:29:57 2023)\n Cal DAC Amplitude: 975 (0.25V)\n\n\nxtalx_z_gl_track_mode\n=====================\nThe xtalx package includes the xtalx_z_gl_track_mode binary that is the core\ntool for use with the density/viscosity sensor. It features a GUI instead of\ncommand-line output. To execute it::\n\n ~% xtalx_z_gl_track_mode\n\n\nxtalx_z_cli_track_mode\n======================\nThe xtalx package includes the xtalx_z_cli_track_mode binary that is similar\nto the GUI track mode tool but only prints log messages to the console and\nwrite measurements to the .csv files. This allows it to be run on a headless\nsystem. To execute it::\n\n ~% xtalx_z_cli_track_mode\n\n\nWindows use\n===========\nOn Windows, the binaries are all launched via the command line just like on\nLinux and macOS, however Windows can't automatically find them. In order to\nlaunch them, you need to execute them using their full Python path as follows::\n\n python3 -m xtalx.tools.p_sensor.discover\n python3 -m xtalx.tools.p_sensor.xtalx_test_yield\n python3 -m xtalx.tools.z_sensor.discover\n python3 -m xtalx.tools.z_sensor.get_info\n python3 -m xtalx.tools.z_sensor.gl_track_mode\n\nOn Windows, it is also common to have the Python interpreter installed under\nthe name \"py\" or \"py3\", so if \"python3\" does not work for you it is recommended\nto try one of the shorter command names. If the Python interpreter cannot be\nfound, it may not be installed at all so should be installed via the Microsoft\nStore (it is a free, open-source install).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Drivers and tools for the XtalX sensor family.",
"version": "1.2.8",
"project_urls": {
"Homepage": "https://github.com/phasesensors/xtalx_python"
},
"split_keywords": [
"xtalx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0cae7247d159327b1750b954ce94cb7f4e750d08a089b256955b1831910dc634",
"md5": "081b0ef7dfe9e7d905c1d9aaf47cc50a",
"sha256": "b0a2e21a410c0fc6ea2f13d998e378f2e801a9e6b7e2b8d7e3afcce06bf431f6"
},
"downloads": -1,
"filename": "xtalx-1.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "081b0ef7dfe9e7d905c1d9aaf47cc50a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 78028,
"upload_time": "2024-11-09T23:26:36",
"upload_time_iso_8601": "2024-11-09T23:26:36.826143Z",
"url": "https://files.pythonhosted.org/packages/0c/ae/7247d159327b1750b954ce94cb7f4e750d08a089b256955b1831910dc634/xtalx-1.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1c9ba83c11483109ba982a0e09b3d1cb8a6a83e5b264292e780c5c157beeb5b",
"md5": "a080ae2fcf81eaad5e6ea01b50ba59d9",
"sha256": "1e0ade1f1c38ea824e8c8e6720a3e9d946a941d918fd6fd0ccca67d6fe59e62c"
},
"downloads": -1,
"filename": "xtalx-1.2.8.tar.gz",
"has_sig": false,
"md5_digest": "a080ae2fcf81eaad5e6ea01b50ba59d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 58853,
"upload_time": "2024-11-09T23:26:38",
"upload_time_iso_8601": "2024-11-09T23:26:38.628595Z",
"url": "https://files.pythonhosted.org/packages/e1/c9/ba83c11483109ba982a0e09b3d1cb8a6a83e5b264292e780c5c157beeb5b/xtalx-1.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-09 23:26:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "phasesensors",
"github_project": "xtalx_python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "xtalx"
}
JSON
