Digital Inputs

class digitalIn.DigitalIn

Bases: Schedule

Class which implements the DIN features.

Any device which has Digital IN should implement this Class. It contains all the necessary methods to use the digital inputs of a VPixx device.

getBaseAddress()

Gets the Ram buffer start address.

This method allows the user to get the RAM buffer start address used in schedules. It should only be used if the user wants the schedules to wrap when it has reached its maximum size. When schedules are expected to wrap, the user should also use setBufferSize().

Returns:	Any value in a range of 0 up to the RAM size.
Return type:	int

getBitDirection()

Gets the port direction mask.

User can obtain the value in decimal or hexadecimal.

Returns:	Bit set to 1 is an enabled port. Bit set to 0 is a disabled port.
Return type:	int

getBufferSize()

Gets the Ram buffer size.

This method allows the user to get the RAM buffer size used in schedules.

Returns:	Any value in a range of 0 up to the RAM size.
Return type:	int

getDinLogStatus(dinStatusDic)

Takes a dictionary and populates it with the following digital input status information:

Parameters:

inDict (Dictionary) –

“doutDinLoopback” is 1 if digital inputs are driven internally by digital outputs, or 0 if digital inputs report real inputs from db-25 connector.
”dataDirection” is a mask showing which of the 24 bits are driving their outputs.
”dataOutStrength” is the drive strength for the ports whose outputs have been enabled by SetDinDataDirection.
”debounce” is 1 if digital inputs are debounced for 30 milliseconds.
”logRunning” is 1 if transition logging is currently active, or 0 if stopped.
”bufferBaseAddress” is the acquisition data buffer base address within the Datapixx.
”bufferSize” is the number of bytes in the acquisition data buffer.
”numBufferFrames” is the total number of samples which fit in the acquisition data buffer.
”currentWriteFrame” is the buffer frame which will be written by the next acquired sample.
”currentReadFrame” is the buffer frame which will be read by the next call to ReadDinLog.
”newLogFrames” = currentWriteFrame - currentReadFrame. This is the maximum number of frames which can be read by the next call to ReadDinLog, without causing an underflow.
”numLogUnderflows” is the number of ReadDinLog underflows which have occurred since SetDinLog. See ReadDinLog for details. See DatapixxSimonGame, DatapixxDin*Demo files for examples.

See also

startDinLog, DinLog, stopDinLog, ReadDinLog

getNbrOfBit()

Gets the number of bit available.

Returns:	Number of bits.
Return type:	int

getOutputStrength()

Gets the strength of the driven outputs.

This method allows the user to get the strength currently driven by the outputs. The implementation uses values from 1/16 up to 16/16. Therefore minimum strength will be 0.0625 and maximum will be 1. The strength can be increased by 0.0625 up to 1.

Returns:	Any value in a range of 0 to 1.
Return type:	float

getOutputValue()

Gets the data which is being driven on each output port.

This method allows the user to get the data which is currently driven on the output port.

Returns:	Any value in a range of 0 to 16777215.
Return type:	int

getScheduleCount()

Gets the schedule count value.

This method allows the user to get the current count for a schedule.

Returns:	Any positive value equal to or greater than 0.
Return type:	int

getScheduleOnset()

Gets the schedule onset value.

This method allows the user to get the schedule onset value used in schedules. The onset represents a nanosecond delay between schedule start and first sample.

Returns:	Any positive value equal to or greater than 0.
Return type:	int

See also

setScheduleOnset

getScheduleRate()

Gets the schedule rate value.

This method allows the user to get the schedule rate value used in schedules. The rate represents the speed at which the schedule updates.

Returns:	Any positive value equal to or greater than 0.
Return type:	int

See also

setScheduleRate, getScheduleUnit

getScheduleUnit()

Gets the schedule unit value.

This method allows the user to get the schedule unit value used in schedules.

Returns:	Any positive value equal to or greater than 0.
Return type:	int

See also

getScheduleRate, setScheduleRate

getValue()

Gets the current value of the bits.

Returns:	Value of bits.
Return type:	int

getWriteAddress()

Gets the Ram buffer write address.

This method allows the user to get the RAM buffer write address used in schedules.

Returns:	Any value in a range of 0 up to the RAM size.
Return type:	int

isCountDownEnabled()

Verifies the schedule count down mode.

Returns:	True if the schedule is decrementing at every sample, False otherwise.
Return type:	enable (Bool)

isDebounceEnabled()

Verifies if the input debounce mode is enabled.

Returns:	True if transitions are being stabilized, False otherwise.
Return type:	debouce (Bool)

isLogEventsEnabled()

Verifies if the transition log events mode is enabled.

Returns:	True if transition log events mode is enabled, False otherwise.
Return type:	enable (Bool)

See also

setLogEvents

isLogTimetagsEnabled()

Verifies if the timetag mode is enabled.

Returns:	True if timetag mode is enabled, False otherwise.
Return type:	enable (Bool)

See also

setLogTimetags

isLoopbackEnabled()

Verifies the digital inputs and outputs loopback mode.

Returns:	True if transitions are being stabilized, False otherwise.
Return type:	enable (Bool)

See also

setLoopback

isScheduleRunning()

Verifies if a schedule is currently running on the subsystem.

Returns:	True if a schedule is currently running, False otherwise.
Return type:	schedule_running (Bool)

See also

startSchedule, stopSchedule

isStabilizeEnabled()

Verifies if the input transitions are being stabilized.

Returns:	True if transitions are being stabilized, False otherwise.
Return type:	stabilize (Bool)

readDinLog(frameDataDic, nReadFrames=0)

Get the digital input log data from the internal log buffer to the local host.

Parameters:	frameDataDic (Dictionary) – “logData” is a row vector of acquired digital input values. Each column of the vector contains an unsigned integer with the new state of digital inputs 0 to 15 after a transition. ”logTimetags” is a row vector of acquisition timetags, indicating when the corresponding transition to the state in logData occurred. The timetags are in double precision seconds since Datapixx powerup. Response times can be calculated by calling SetMarker() at stimulus onset, then subtracting GetMarker() from the logged timetags. ”underflow” is set to 1 if calls to ReadDinLog read too many frames. The newLogFrames field returned by GetDinStatus indicates the maximum number of frames which can be read by ReadDinLog. If more than this number of frames is read, an underflow occurs and there will be errors in the logged data. In addition to returning an underflow flag, the numLogUnderflows field returned by GetDinStatus will be incremented. See DatapixxSimonGame, DatapixxDinDemo files for examples. nReadFrames* (int) – The number of frames to upload, and should not exceed newLogFrames returned by GetDinStatus. If numFrames argument is missing, ReadDinLog will return all remaining logged data.
Returns:	Complete list with pairs of timestamp and values.
Return type:	DinData (list)

setBaseAddress(address)

Sets the Ram buffer start address.

This method allows the user to set the RAM buffer start address used in schedules. The given address must be an even value.

Parameters:

address (int) – Any value in a range of 0 up to the RAM size.

setBitDirection(bit_mask)

Sets the port direction mask.

Sets the port direction for each bit. The mask is one value representing all bits from the port. The given bit_mask will set the direction of all digital input bits. For each bit which should drive its port, the corresponding bit_mask value should be set to 1. An hexadecimal bit_mask can be provided.

For example, bit_mask = 0x0000F will enable the port for the first 4 bits on the right. All other ports will be disabled. User can then use the first 4 bits to drive the port.

Parameters:

int – Set bit to 1 to enable the port for that bit. Set bit to 0 to disable it.

setBufferSize(buffer_size)

Sets the Ram buffer size.

This method allows the user to set the RAM buffer size used in schedules. It should only be used if the user wants the schedule to wrap when it has reached its maximum size. When schedules are expected to wrap, the user should also use setBaseAddress(). The given size is in bytes and must be an even value.

Parameters:

buffer_size (int) – Any value in a range of 0 up to the RAM size.

setDebounce(enable)

Sets the input debounce mode.

This method allows the user to enable or disable the input debounce mode. When a DIN transitions, ignore further DIN transitions for the next 30 milliseconds. This is useful for response buttons. When disabled, the inputs transitions are immediately recognized. In which case, it can be useful to enable debouncing using setStabilize().

Parameters:

enable (Bool) – True if transitions are being debounced, False otherwise.

setDinLog(buffBaseAddr=12000000, numBuffFrames=1000)

Configure digital input transition logging. The log reports rising and falling edges of the digital inputs, with associated timetags, and is the best way to monitor button box responses or read parallel port data.

Note that the first call to StartDinLog must be preceeded by a call to SetDinLog to initialize and clear the log. Once SetDinLog has been called, StartDinLog and StopDinLog may be called multiple times to enable and disable logging. Note that logged timetags are implemented in hardware with microsecond precision.

Parameters:	bufferBaseAddress (int) – Specifies the start of the RAM buffer which should hold the logged data inside the Datapixx. Use ReadDinLog to upload the logged data from this address after calling StartDinLog. numBufferFrames (int) – Specifies the desired size of the log buffer in the Datapixx RAM. This buffer is circular, so it must be large enough to hold all logged transitions between successive calls to ReadDinLog. newLogFrames returned by GetDinStatus indicates the number of transitions logged since the last call to ReadDinLog.
Returns:	An empty dictionary to be used with getDinLogStatus
Return type:	dinStatusDic (dictionary)

See also

EnableDinDebounce, StartDinLog, StopDinLog, GetDinStatus, ReadDinLog

setLogEvents(enable)

Sets the transition log events mode on data samples.

This method allows the user to enable or disable the transition log events on acquired data. When enabled, each transition is automatically logged. No schedule is required. This is the best way to log response buttons. When disabled, logging of transitions is done automatically.

Parameters:

enable (Bool) – True to activate the log event mode, False otherwise.

See also

isLogEventsEnabled

setLogTimetags(enable)

Sets the timetag mode on the data samples.

This method allows the user to enable or disable the timetag on acquired data. When enabled, each buffered sample is preceded with a 64-bit nanosecond timetag. When disabled, buffered data has no timetags.

Parameters:

enable (Bool) – True to activate the timetag mode, False otherwise.

See also

isLogTimetagsEnabled

setLoopback(enable)

Sets the digital inputs and outputs loopback mode.

This method allows the user to enable or disable the loopback between digital output ports and digital inputs. When enabled, the digital outputs send their data to the digital inputs. When disabled, the digital inputs will not get the digital outputs data. debouncing using “setStabilize()”.

Parameters:

enable (Bool) – True if loopback is enabled, False otherwise.

See also

isLoopbackEnabled

setOutputStrength(strength)

Sets the strength of the driven outputs.

This method allows the user to set the current (Ampere) strength of the driven outputs. The implementation actual values uses 1/16 up to 16/16. So minimum strength will be 0.0625 and maximum will be 1. The strength can be increased by 0.0625 up to 1. Giving a strength of 0 will thus set it to 0.0625. Giving a strength between 0.0625 and 0.125 will round the given strength to one of the two increments.

The strength is the same for all bits.

Parameters:

strength (float) – Any value in a range of 0 to 1.

setOutputValue(value)

Sets the data which should be driven on each port.

In order to be able to drive the ports with the given value, the port direction has to be properly enabled. This can be done using the “setBitDirection()” with the appropriate bit mask.

Parameters:

value (int) – Any value in a range of 0 to 16777215.

setScheduleCount(count)

Sets the schedule count.

This method allows the user to set the schedule count for a schedule with a fixed number of sample. In which case, the schedule will decrement at a given rate and stop when the count reaches 0.

Parameters:

count (int) – Any positive value greater than 0.

setScheduleCountDown(enable)

Sets the schedule count down mode.

This method allows the user to enable or disable the count down on a schedule. When enabled, the schedule decrements at the given rate and stops automatically when count hits 0. When disabled, the schedule increments at the given rate and is stopped by calling stopSchedule().

Parameters:

enable (Bool) – True if count down is enabled, False otherwise.

setScheduleOnset(onset)

Sets the schedule onset value.

This method allows the user to set the nanosecond delay between schedule start and first sample. If no delay is required, this method does not need to be used. Default value is 0.

Parameters:

onset (int) – Any positive value equal to or greater than 0.

See also

getScheduleOnset

setScheduleRate(rate, unit='hz')

Sets the schedule rate.

This method allows the user to set the schedule rate. Since the rate can be given with different units, the method also needs to have a unit associated with the rate.

Parameters:

rate (int) – Any positive value equal to or greater than 0.
unit (str) – hz : samples per second, maximum 1 MHz. video : samples per video frame, maximum 1 MHz. nano : sample period in nanoseconds, minimum 1000 ns.

See also

getScheduleRate, getScheduleUnit

setStabilize(enable)

Sets the input stabilization mode.

This method allows the user to enable or disable the input transitions stabilization. When enabled, input transitions are only recognized after the entire input bus has been stable for 80 ns. This is useful for deskewing parallel busses, and ignoring transmission line reflections. When disabled, the input transitions are immediately recognized. In which case, it can be useful to enable debouncing using setDebounce().

Parameters:

enable (Bool) – True if transitions are being stabilized, False otherwise.

setWriteAddress(address)

Sets the Ram buffer write address.

This method allows the user to set the RAM buffer write address used in schedules. This address is used by the schedule to know where the data should be first written to. The schedule will then write the following data to the address following the RAM buffer write address.

The given address must be an even value.

Parameters:

address (int) – Any value in a range of 0 up to the RAM size.

startDinLog(): Starts the digital input log on the next registers update. Any transition will be recorded in this log.

See also

setDinLog, stopDinLog

startSchedule()

Starts a schedule.

Schedules may be configured in different ways, affecting their behavior. Before a schedule is started, the user should make sure that it is properly set in the right mode.

stopDinLog(): Stops the digital input log on the next registers update.

See also

setDinLog, stopDinLog

stopSchedule()

stop the active schedule for a given subsystem.

Depending on how the Schedules are configured, it may not be necessary to call this method. When a schedule is using a count down, it is not required to stop the schedule.