Skip to content

tinkerforge

DVCurrent

Bases: DVTF

A dependent tinkerforge variable representing the current.

Source code in autora/variable/tinkerforge.py 
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
class DVCurrent(DVTF):
    """
    A dependent tinkerforge variable representing the current.
    """

    _name = "current0"
    _UID = "Hfg"
    _variable_label = "Current 0"
    _units = "mA"
    _priority = 0
    _value_range = (0, 2000)
    _value = 0

    _HOST = "localhost"
    _PORT = 4223
    channel = 0

    def __init__(self, *args, **kwargs):
        """
        Initializes Industrial Analog Out 2.0 device.

        For arguments, see [autora.variable.tinkerforge.TinkerforgeVariable]
        [autora.variable.tinkerforge.TinkerforgeVariable.__init__]
        """

        super(DVCurrent, self).__init__(*args, **kwargs)

        self._ipcon = IPConnection()  # Create IP connection
        self._id020 = BrickletIndustrialDual020mAV2(
            self._UID, self._ipcon
        )  # Create device object

        self._ipcon.connect(self._HOST, self._PORT)  # Connect to brickd

        if self._name == "current1":
            self.channel = 1
        else:
            self.channel = 0

    def disconnect(self):
        """
        Disconnect from up measurement device.
        """

        self._ipcon.disconnect()

    def measure(self):
        """
        Measures the current.
        """
        current = self._id020.get_current(self.channel)
        self.set_value(current / 1000000.0)

__init__(*args, **kwargs)

Initializes Industrial Analog Out 2.0 device.

For arguments, see autora.variable.tinkerforge.TinkerforgeVariable

Source code in autora/variable/tinkerforge.py 
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
def __init__(self, *args, **kwargs):
    """
    Initializes Industrial Analog Out 2.0 device.

    For arguments, see [autora.variable.tinkerforge.TinkerforgeVariable]
    [autora.variable.tinkerforge.TinkerforgeVariable.__init__]
    """

    super(DVCurrent, self).__init__(*args, **kwargs)

    self._ipcon = IPConnection()  # Create IP connection
    self._id020 = BrickletIndustrialDual020mAV2(
        self._UID, self._ipcon
    )  # Create device object

    self._ipcon.connect(self._HOST, self._PORT)  # Connect to brickd

    if self._name == "current1":
        self.channel = 1
    else:
        self.channel = 0

disconnect()

Disconnect from up measurement device.

Source code in autora/variable/tinkerforge.py 
281
282
283
284
285
286
def disconnect(self):
    """
    Disconnect from up measurement device.
    """

    self._ipcon.disconnect()

measure()

Measures the current.

Source code in autora/variable/tinkerforge.py 
288
289
290
291
292
293
def measure(self):
    """
    Measures the current.
    """
    current = self._id020.get_current(self.channel)
    self.set_value(current / 1000000.0)

DVTF

Bases: DV, TinkerforgeVariable

A representation of a dependent variable used in the Tinkerforge environment.

Source code in autora/variable/tinkerforge.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
class DVTF(DV, TinkerforgeVariable):
    """
    A representation of a dependent variable used in the Tinkerforge environment.
    """

    def __init__(self, *args, **kwargs):
        """
        Initializes a dependent variable used in the Tinkerforge environment.

        For arguments, see [autora.variable.tinkerforge.TinkerforgeVariable]
        [autora.variable.tinkerforge.TinkerforgeVariable.__init__]
        """
        DV.__init__(self, *args, **kwargs)
        TinkerforgeVariable.__init__(self, *args, **kwargs)

__init__(*args, **kwargs)

Initializes a dependent variable used in the Tinkerforge environment.

For arguments, see autora.variable.tinkerforge.TinkerforgeVariable

Source code in autora/variable/tinkerforge.py 
109
110
111
112
113
114
115
116
117
def __init__(self, *args, **kwargs):
    """
    Initializes a dependent variable used in the Tinkerforge environment.

    For arguments, see [autora.variable.tinkerforge.TinkerforgeVariable]
    [autora.variable.tinkerforge.TinkerforgeVariable.__init__]
    """
    DV.__init__(self, *args, **kwargs)
    TinkerforgeVariable.__init__(self, *args, **kwargs)

DVVoltage

Bases: DVTF

A dependent tinkerforge variable representing the voltage.

Source code in autora/variable/tinkerforge.py 
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
class DVVoltage(DVTF):
    """
    A dependent tinkerforge variable representing the voltage.
    """

    _name = "voltage0"
    _UID = "MjY"
    _variable_label = "Voltage 0"
    _units = "mV"
    _priority = 0
    _value_range = (-3500, 3500)
    _value = 0

    _HOST = "localhost"
    _PORT = 4223

    channel = 0

    def __init__(self, *args, **kwargs):
        """
        Initializes Industrial Analog Out 2.0 device.

        For arguments, see [autora.variable.tinkerforge.TinkerforgeVariable]
        [autora.variable.tinkerforge.TinkerforgeVariable.__init__]
        """

        super(DVVoltage, self).__init__(*args, **kwargs)

        self._ipcon = IPConnection()  # Create IP connection
        self._idai = BrickletIndustrialDualAnalogInV2(
            self._UID, self._ipcon
        )  # Create device object

        self._ipcon.connect(self._HOST, self._PORT)  # Connect to brickd

        if self._name == "voltage1":
            self.channel = 1
        else:
            self.channel = 0

    def disconnect(self):
        """
        Disconnect from up measurement device.
        """
        self._ipcon.disconnect()

    def measure(self):
        """
        Measures the voltage.
        """
        value = self._idai.get_voltage(self.channel)
        self.set_value(value)

__init__(*args, **kwargs)

Initializes Industrial Analog Out 2.0 device.

For arguments, see autora.variable.tinkerforge.TinkerforgeVariable

Source code in autora/variable/tinkerforge.py 
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
def __init__(self, *args, **kwargs):
    """
    Initializes Industrial Analog Out 2.0 device.

    For arguments, see [autora.variable.tinkerforge.TinkerforgeVariable]
    [autora.variable.tinkerforge.TinkerforgeVariable.__init__]
    """

    super(DVVoltage, self).__init__(*args, **kwargs)

    self._ipcon = IPConnection()  # Create IP connection
    self._idai = BrickletIndustrialDualAnalogInV2(
        self._UID, self._ipcon
    )  # Create device object

    self._ipcon.connect(self._HOST, self._PORT)  # Connect to brickd

    if self._name == "voltage1":
        self.channel = 1
    else:
        self.channel = 0

disconnect()

Disconnect from up measurement device.

Source code in autora/variable/tinkerforge.py 
336
337
338
339
340
def disconnect(self):
    """
    Disconnect from up measurement device.
    """
    self._ipcon.disconnect()

measure()

Measures the voltage.

Source code in autora/variable/tinkerforge.py 
342
343
344
345
346
347
def measure(self):
    """
    Measures the voltage.
    """
    value = self._idai.get_voltage(self.channel)
    self.set_value(value)

IVCurrent

Bases: IVTF

An independent tinkerforge variable representing the current.

Source code in autora/variable/tinkerforge.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
class IVCurrent(IVTF):
    """
    An independent tinkerforge variable representing the current.
    """

    _name = "source_current"
    _UID = "MST"
    _variable_label = "Source Current"
    _units = "µA"
    _priority = 0
    _value_range = (0, 20000)
    _value = 0

    _HOST = "localhost"
    _PORT = 4223

    def __init__(self, *args, **kwargs):
        """
        Initializes Industrial Analog Out 2.0 device.

        For arguments, see [autora.variable.tinkerforge.TinkerforgeVariable]
        [autora.variable.tinkerforge.TinkerforgeVariable.__init__]
        """

        self._ipcon = IPConnection()  # Create IP connection
        self._iao = BrickletIndustrialAnalogOutV2(
            self._UID, self._ipcon
        )  # Create device object

        self._ipcon.connect(self._HOST, self._PORT)  # Connect to brickd

        super(IVCurrent, self).__init__(*args, **kwargs)

    def disconnect(self):
        """
        Disconnect from up measurement device.
        """

        self._iao.set_enabled(False)

        self._ipcon.disconnect()

    def stop(self):
        """
        Disable current output
        """

        self._iao.set_enabled(False)

    def manipulate(self):
        """
        Sets the current output to the specified value.
        """
        self._iao.set_current(self.get_value())
        self._iao.set_enabled(True)

    def clean_up(self):
        """
        Clean up measurement device.
        """
        self.stop()

__init__(*args, **kwargs)

Initializes Industrial Analog Out 2.0 device.

For arguments, see autora.variable.tinkerforge.TinkerforgeVariable

Source code in autora/variable/tinkerforge.py 
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
def __init__(self, *args, **kwargs):
    """
    Initializes Industrial Analog Out 2.0 device.

    For arguments, see [autora.variable.tinkerforge.TinkerforgeVariable]
    [autora.variable.tinkerforge.TinkerforgeVariable.__init__]
    """

    self._ipcon = IPConnection()  # Create IP connection
    self._iao = BrickletIndustrialAnalogOutV2(
        self._UID, self._ipcon
    )  # Create device object

    self._ipcon.connect(self._HOST, self._PORT)  # Connect to brickd

    super(IVCurrent, self).__init__(*args, **kwargs)

clean_up()

Clean up measurement device.

Source code in autora/variable/tinkerforge.py 
176
177
178
179
180
def clean_up(self):
    """
    Clean up measurement device.
    """
    self.stop()

disconnect()

Disconnect from up measurement device.

Source code in autora/variable/tinkerforge.py 
153
154
155
156
157
158
159
160
def disconnect(self):
    """
    Disconnect from up measurement device.
    """

    self._iao.set_enabled(False)

    self._ipcon.disconnect()

manipulate()

Sets the current output to the specified value.

Source code in autora/variable/tinkerforge.py 
169
170
171
172
173
174
def manipulate(self):
    """
    Sets the current output to the specified value.
    """
    self._iao.set_current(self.get_value())
    self._iao.set_enabled(True)

stop()

Disable current output

Source code in autora/variable/tinkerforge.py 
162
163
164
165
166
167
def stop(self):
    """
    Disable current output
    """

    self._iao.set_enabled(False)

IVTF

Bases: IV, TinkerforgeVariable

A representation of an independent variable used in the Tinkerforge environment.

Source code in autora/variable/tinkerforge.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
class IVTF(IV, TinkerforgeVariable):
    """
    A representation of an independent variable used in the Tinkerforge environment.
    """

    def __init__(self, *args, **kwargs):
        """
        Initializes an independent variable used in the Tinkerforge environment.

        For arguments, see [autora.variable.tinkerforge.TinkerforgeVariable]
        [autora.variable.tinkerforge.TinkerforgeVariable.__init__]
        """
        IV.__init__(self, *args, **kwargs)
        TinkerforgeVariable.__init__(self, *args, **kwargs)

__init__(*args, **kwargs)

Initializes an independent variable used in the Tinkerforge environment.

For arguments, see autora.variable.tinkerforge.TinkerforgeVariable

Source code in autora/variable/tinkerforge.py 
 93
 94
 95
 96
 97
 98
 99
100
101
def __init__(self, *args, **kwargs):
    """
    Initializes an independent variable used in the Tinkerforge environment.

    For arguments, see [autora.variable.tinkerforge.TinkerforgeVariable]
    [autora.variable.tinkerforge.TinkerforgeVariable.__init__]
    """
    IV.__init__(self, *args, **kwargs)
    TinkerforgeVariable.__init__(self, *args, **kwargs)

IVVoltage

Bases: IVTF

An independent tinkerforge variable representing the voltage.

Source code in autora/variable/tinkerforge.py 
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
class IVVoltage(IVTF):
    """
    An independent tinkerforge variable representing the voltage.
    """

    _variable_label = "Source Voltage"
    _UID = "MST"
    _name = "source_voltage"
    _units = "mV"
    _priority = 0
    _value_range = (0, 5000)
    _value = 0

    _HOST = "localhost"
    _PORT = 4223

    def __init__(self, *args, **kwargs):
        """
        Initializes Industrial Analog Out 2.0 device.
        """

        self._ipcon = IPConnection()  # Create IP connection
        self._iao = BrickletIndustrialAnalogOutV2(
            self._UID, self._ipcon
        )  # Create device object

        self._ipcon.connect(self._HOST, self._PORT)  # Connect to brickd

        super(IVVoltage, self).__init__(*args, **kwargs)

    def disconnect(self):
        """
        Disconnect from up measurement device.
        """

        self._iao.set_enabled(False)

        self._ipcon.disconnect()

    def stop(self):
        """
        Disable voltage output
        """
        self._iao.set_enabled(False)

    def manipulate(self):
        """
        Sets the voltage output to the specified value.
        """
        self._iao.set_voltage(self.get_value())
        self._iao.set_enabled(True)

    def clean_up(self):
        """
        Clean up measurement device.
        """
        self.stop()

__init__(*args, **kwargs)

Initializes Industrial Analog Out 2.0 device.

Source code in autora/variable/tinkerforge.py 
199
200
201
202
203
204
205
206
207
208
209
210
211
def __init__(self, *args, **kwargs):
    """
    Initializes Industrial Analog Out 2.0 device.
    """

    self._ipcon = IPConnection()  # Create IP connection
    self._iao = BrickletIndustrialAnalogOutV2(
        self._UID, self._ipcon
    )  # Create device object

    self._ipcon.connect(self._HOST, self._PORT)  # Connect to brickd

    super(IVVoltage, self).__init__(*args, **kwargs)

clean_up()

Clean up measurement device.

Source code in autora/variable/tinkerforge.py 
235
236
237
238
239
def clean_up(self):
    """
    Clean up measurement device.
    """
    self.stop()

disconnect()

Disconnect from up measurement device.

Source code in autora/variable/tinkerforge.py 
213
214
215
216
217
218
219
220
def disconnect(self):
    """
    Disconnect from up measurement device.
    """

    self._iao.set_enabled(False)

    self._ipcon.disconnect()

manipulate()

Sets the voltage output to the specified value.

Source code in autora/variable/tinkerforge.py 
228
229
230
231
232
233
def manipulate(self):
    """
    Sets the voltage output to the specified value.
    """
    self._iao.set_voltage(self.get_value())
    self._iao.set_enabled(True)

stop()

Disable voltage output

Source code in autora/variable/tinkerforge.py 
222
223
224
225
226
def stop(self):
    """
    Disable voltage output
    """
    self._iao.set_enabled(False)

TinkerforgeVariable

Bases: Variable

A representation of a variable used in the Tinkerforge environment.

Source code in autora/variable/tinkerforge.py 
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class TinkerforgeVariable(Variable):
    """
    A representation of a variable used in the Tinkerforge environment.
    """

    _variable_label = ""
    _UID = ""
    _priority = 0

    def __init__(
        self,
        variable_label: str = "",
        UID: str = "",
        name: str = "",
        units: str = "",
        priority: int = 0,
        value_range: Tuple[Any, Any] = (0, 1),
        type: ValueType = float,
    ):
        """
        Initializes a Tinkerforge variable.
        Args:
            variable_label: the label of the variable
            UID: the user identification of the variable
            name: the name of the variable
            units: the units of the variable
            priority: the priority of the variable
            value_range: the value range of the variable
            type: the type of the variable
        """

        super().__init__(
            name=name,
            value_range=value_range,
            units=units,
            type=type,
            variable_label=variable_label,
        )

        self._UID = UID
        self._priority = priority

    def __get_priority__(self) -> int:
        """
        Get priority of variable. The priority is used to determine the sequence of variables
        to be measured or manipulated.

        Returns:
            The priority of the variable.
        """
        return self._priority

    def __set_priority__(self, priority: int = 0):
        """
        Set priority of variable.
        The priority is used to determine the sequence of variables to be measured or manipulated.

        Arguments:
            priority: The priority of the variable.
        """
        self._priority = priority

    @abstractmethod
    def clean_up(self):
        """Clean up measurement device."""
        pass

    @abstractmethod
    def disconnect(self):
        """Disconnect from up measurement device."""
        pass

__get_priority__()

Get priority of variable. The priority is used to determine the sequence of variables to be measured or manipulated.

Returns:

Type Description
int

The priority of the variable.
Source code in autora/variable/tinkerforge.py 
57
58
59
60
61
62
63
64
65
def __get_priority__(self) -> int:
    """
    Get priority of variable. The priority is used to determine the sequence of variables
    to be measured or manipulated.

    Returns:
        The priority of the variable.
    """
    return self._priority

__init__(variable_label='', UID='', name='', units='', priority=0, value_range=(0, 1), type=float)

Initializes a Tinkerforge variable.

Parameters:

Name Type Description Default
variable_label str

the label of the variable

 ''
UID str

the user identification of the variable

 ''
name str

the name of the variable

 ''
units str

the units of the variable

 ''
priority int

the priority of the variable

 0
value_range Tuple[Any, Any]

the value range of the variable

 (0, 1)
type ValueType

the type of the variable

 float
Source code in autora/variable/tinkerforge.py 
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
def __init__(
    self,
    variable_label: str = "",
    UID: str = "",
    name: str = "",
    units: str = "",
    priority: int = 0,
    value_range: Tuple[Any, Any] = (0, 1),
    type: ValueType = float,
):
    """
    Initializes a Tinkerforge variable.
    Args:
        variable_label: the label of the variable
        UID: the user identification of the variable
        name: the name of the variable
        units: the units of the variable
        priority: the priority of the variable
        value_range: the value range of the variable
        type: the type of the variable
    """

    super().__init__(
        name=name,
        value_range=value_range,
        units=units,
        type=type,
        variable_label=variable_label,
    )

    self._UID = UID
    self._priority = priority

__set_priority__(priority=0)

Set priority of variable. The priority is used to determine the sequence of variables to be measured or manipulated.

Parameters:

Name Type Description Default
priority int

The priority of the variable.

 0
Source code in autora/variable/tinkerforge.py 
67
68
69
70
71
72
73
74
75
def __set_priority__(self, priority: int = 0):
    """
    Set priority of variable.
    The priority is used to determine the sequence of variables to be measured or manipulated.

    Arguments:
        priority: The priority of the variable.
    """
    self._priority = priority

clean_up() abstractmethod

Clean up measurement device.

Source code in autora/variable/tinkerforge.py 
77
78
79
80
@abstractmethod
def clean_up(self):
    """Clean up measurement device."""
    pass

disconnect() abstractmethod

Disconnect from up measurement device.

Source code in autora/variable/tinkerforge.py 
82
83
84
85
@abstractmethod
def disconnect(self):
    """Disconnect from up measurement device."""
    pass