Skip to content

Frame

Frame

ScientISST Device Frame class

A frame returned by ScientISST.read()

Attributes:

Name Type Description
seq int

Frame sequence number (0...15).

This number is incremented by 1 on each consecutive frame, and it overflows to 0 after 15 (it is a 4-bit number).

This number can be used to detect if frames were dropped while transmitting data.
digital list

Array of digital ports states (False for low level or True for high level).

On original ScientISST, the array contents are: I1 I2 I3 I4.

On ScientISST 2, the array contents are: I1 I2 O1 O2.
a list

Array of raw analog inputs values of the active channles.

If all channels are active, a will have 8 elements: 6 AIs and 2 AXs.
mv list

Array of analog inputs values of the active channles in mV.

If all channels are active, mv will have 8 elements: 6 AIs and 2 AXs.
Source code in scientisst/frame.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class Frame:
    """
    ScientISST Device Frame class

    A frame returned by ScientISST.read()

    Attributes:
        seq (int): Frame sequence number (0...15).

            This number is incremented by 1 on each consecutive frame, and it overflows to 0 after 15 (it is a 4-bit number).

            This number can be used to detect if frames were dropped while transmitting data.

        digital (list): Array of digital ports states (False for low level or True for high level).

            On original ScientISST, the array contents are: I1 I2 I3 I4.

            On ScientISST 2, the array contents are: I1 I2 O1 O2.

        a (list): Array of raw analog inputs values of the active channles.

            If all channels are active, `a` will have 8 elements: 6 AIs and 2 AXs.

        mv (list): Array of analog inputs values of the active channles in mV.

            If all channels are active, `mv` will have 8 elements: 6 AIs and 2 AXs.
    """

    digital = [0] * 4
    seq = -1

    def __init__(self, num_channels):
        self.a = [0] * num_channels
        self.mv = [0] * num_channels

    def to_map(self):
        return {
            "sequence": self.seq,
            "analog": self.a,
            "digital": self.digital,
            "mv": self.mv,
        }

    def __str__(self):
        if self.mv[0]:
            values = [str(val) for pair in zip(self.a, self.mv) for val in pair]
        else:
            values = map(str, self.a)

        return "{}\t{}\t{}\t{}\t{}\t{}".format(
            self.seq,
            self.digital[0],
            self.digital[1],
            self.digital[2],
            self.digital[3],
            "\t".join(values),
        )

    def to_matrix(self):
        if self.mv[0]:
            return (
                [self.seq]
                + self.digital
                + [val for pair in zip(self.a, self.mv) for val in pair]
            )
        else:
            return [self.seq] + self.digital + self.a
Last update: 2021-11-30