newaetech / chipshouter-python Goto Github PK

Hi

I'm not sure why https://chipshouter.readthedocs.io/en/latest/ is not reflecting automatically latest master, but e.g. the very first example still mentions "cs.arm = 1" while master doc is fixed : https://github.com/newaetech/ChipSHOUTER-python/blob/master/chipshouter/chipshouter.py#L58

Suggesting to improve the API to make more obvious & less reliant on all the side effects. In particular:

arm() --> .armed = 1
force_arm() --> .clr_armed = 1
trigger() --> pulse = 1
reset() --> reset = 1 (breaking change)
reset_config() --> reset_config = 1 (breaking change)
trigger_safe() --> read of trigger_safe (breaking change)

Most of the changes are related to less used features, so I imagine this isn't as big a deal. Leaving open for anyone to complain about...

Actual width is not correctly reflected when using the API call,
Calling:

	cs.pulse.width = 101
	print cs.pulse

Returns:

width        = 101
repeat       = 10
deadtime     = 1
actual width = 0

See line 278:

def __init__(self, comport):
    self.com_api = Bin_API("COM10")

Should be

def __init__(self, comport):
    self.com_api = Bin_API(comport)

I'm a bit puzzled...
Using an external hardware trigger.

The user manual recommends to call get triggersafe, else the device will enter fault mode if safety checks cannot be performed for a certain length of time.
The Python API tells that reading trigger_safe will allow triggering for 5 seconds without checking the temperature.

The user manual presents absent_temp as the configurable time (1..60, unit unknown, seconds?) the temperature sensors can be skipped being read.
The Python API specifies unit is seconds but doesn't specify the allowed interval.

Now, from my tests:

• if I don't read trigger_safe at all, the CS will enter fault mode only after quite a while.
• if I read trigger_safe before repeated triggers, CS will enter fault mode systematically 5s later (as documented in the Python API), no matter the value of absent_temp.

I thought I could use absent_temp to configure the maximum delay between regular reads of trigger_safe but it's not the case ? What is absent_temp for then ?
And why calling trigger_safe reduces drastically the time between entering fault mode compared with not calling trigger_safe ?

If CS isn't connected, printing cs object gives you:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "chipshouter.py", line 839, in __repr__
    return dict_to_str(self._dict_repr())
  File "chipshouter.py", line 827, in _dict_repr
    dict['absentTemp']          = self.absentTemp
AttributeError: 'ChipSHOUTER' object has no attribute 'absentTemp'