# pysalx
`pysalx` - scripts for interacting with the SciAps XRF and LIBS analyzers.


# Status
Alpha software under development.


# Installation
Tools to interact with the device are available in most free software
oriented distributions, such as Debian.

Install on a Debian workstation (running as user `debian`, hostname `workstation`)
example:

```
debian@workstation:~$ git clone https://spacecruft.org/spacecruft/pysalx
debian@workstation:~$ sudo apt update
debian@workstation:~$ sudo apt install adb
debian@workstation:~$ cd pysalx/
```


# HOWTO
See `./scripts/` directory in this repo for current scripts.

Current scripts:

* `pysalx-api-config` --- Get analyzer configuration via API.
* `pysalx-api-id` --- Get analyzer ID via API.
* `pysalx-api-port` --- Forward web port 8080 via USB to localhost.
* `pysalx-api-status` --- Get analyzer status via API.
* `pysalx-api-test` --- Do Analyzer test via API.
* `pysalx-api-wlcalibration` --- Get analyzer wavelength calibration via API.
* `pysalx-backup-export` --- Backup the export directory, with spectra from
   templates.
* `pysalx-backup-extsd` --- Backup the ext SD card.
* `pysalx-backup-fs` --- Backup whole file system. Not yet.
* `pysalx-backup-sd` --- Backup the SD card.
* `pysalx-date-set` --- Set time/date on analyzer using workstation's time.
* `pysalx-install-deps` --- Install script dependencies (initial setup).
* `pysalx-record` --- Display device screen. XXX TODO
* `pysalx-screen` --- Display device screen on workstation.
* `pysalx-log` --- View the analyzer logfile in semi-real-time.


## Usage
You may need to set up permissions to access the device as non-root.

Run:
```
debian@workstation$ adb root
# If you don't have perms, something like:
debian@workstation:~$ sudo adb root
```

It should then say you are connected.


To see files, after connecting as show above. Examples (output not shown):

```
# See top level directory:
debian@workstation:~$ adb ls /

# See main sdcard where captured samples and photos are stored (main dir):
debian@workstation:~$ adb ls /storage/sdcard0/
```

To view debug logs in realtime:

```
debian@workstation:~$ adb shell tail -f /storage/sdcard0/ngl.log
```

# Notes
See more notes in the `doc/` directory.


# Other Useful Apps
To view the screen of the device remotely via USB, install
`scrcpy`.

```
sudo apt update
sudo apt install scrcpy
./scripts/
```

# SciAps Analyzers
In sum, they are Android-derived 64-bit ARM systems.
So they interact with standard free software Android
tools such as "Android Debug Bridge" (`adb`).


Equipment:


Z-903 LIBS Analyzer

* https://sciaps.com/libs-handheld-laser-analyzers/z-903-libs/

X-555 XRF Analyzer

* https://sciaps.com/xrf-handheld-x-ray-analyzers/x-555-xrf-gun/


## SciAps Resources
SciAps sites.

* https://sciaps.com/
* https://www.youtube.com/c/SciAps/videos
* https://github.com/SciAps


# Unofficial
This repository, documentation and code is
unofficial, unaffiliated with SciAps.


# License
GPLv3+.


Copyright (C) 2022, Jeff Moe