All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
0.8.0 - 2024-03-20
- [spotwave]
SpotWave.get_tr_snapshot
method - [spotwave]
SpotWave.start_pulsing
,SpotWave.stop_pulsing
methods
- Use common
Info
,Status
andSetup
dataclass for both spotWave and linWave - [linwave] Deprecate
LinWave.set_range
method, useLinWave.set_range_index
instead - [linwave] Remove
Info.max_sample_rate
field - [spotwave] Deprecate
SpotWave.get_data
, useSpotWave.get_tr_snapshot
instead - [spotwave] Remove
sync
parameter ofSpotWave.set_cct
method - Remove deprecated
conditionwave
module
0.7.1 - 2023-10-18
- [spotwave] Return device names/paths from
SpotWave.discover
method, e.g./dev/ttyACM0
instead ofttyACM0
on Linux systems
0.7.0 - 2023-10-17
- [linwave]
LinWave.set_range_index
method - [linwave]
LinWave.identify
method to blind all LEDs or single channel to identify device/channel - [linwave]
LinWave.get_tr_snapshot
method (experimental) - [linwave] Add
hardware_id
toget_info
output - [spotwave]
LinWave.identify
method to blind LED - Add Python 3.11 and 3.12 to CI pipeline
- Examples:
linwave_pulsing
linwave_cont_tr
- [spotwave] Remove
cct_seconds
field inget_setup
responseSetup
- [spotwave] Make
readlines
method private - List input range(s) in
get_info
responseInfo.input_range
(human-readable format)- Remove
linwave.Info.range_count
field - Remove
spotwave.Info.input_range_decibel
field
- Remove
0.6.0 - 2022-08-01
- [linwave] Timeout parameter for
LinWave.stream
method (to detect buffer overflows), default: 5 s
- [linwave] Discovery port binding of client
- [linwave] Reduce CPU load in stream by setting TCP limit/buffer
0.5.0 - 2022-06-21
poll_interval_seconds
parameter forSpotWave.acquire
andConditionWave.acquire
/LinWave.acquire
method
- Rename
ConditionWave
toLinWave
(and the corresponding moduleconditionwave
tolinwave
). TheConditionWave
class is still an alias for theLinWave
class but deprecated and will be removed in the future
- [linwave] Fix timeouts for multiline responses (
get_info
,get_status
,get_setup
)
0.4.1 - 2022-06-20
- [linwave] Increase TCP read timeout for
get_ae_data
/get_tr_data
to prevent timeout errors
0.4.0 - 2022-05-17
- [linwave] Add all commands of new firmware (hit-based acquisition, pulsing, ...)
- [linwave] Add example for hit-based acquisition
- Add Python 3.9 and 3.10 to CI pipeline
- [linwave] Rename
set_decimation
method toset_tr_decimation
- [linwave] Remove
get_temperature
andget_buffersize
method (replace withget_status
method) - [spotWave] Rename
stream
method toacquire
.stream
method is still an alias but deprecated and will be removed in the future
- [linwave] Wait for all stream connection before
start_acquisition
0.3.0 - 2021-06-15
- [linwave] Multi-channel example
- [linwave] Optional
start
argument (timestamp) forstream
- [spotWave] Add examples
- [spotWave] Add firmware check
- [linwave] Channel arguments for
set_range
,set_decimation
andset_filter
- [spotWave]
set_status_interval
with seconds instead of milliseconds - [spotWave] Require firmware >= 00.25
- [linwave] Properties
input_range
,decimation
,filter_settings
- [linwave] ADC to volts conversion factor
- [spotWave] Aggregate TR/AE records to prevent IO timeouts
0.2.0 - 2020-12-18
First public release