Morgane Oger > Device-Velleman-K8055-Fuse-1.0 > Device::Velleman::K8055::Fuse

Download:
Device-Velleman-K8055-Fuse-1.0.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.0   Source  

NAME ^

Device::Velleman::K8055::Fuse - Communication with the Velleman K8055 USB experiment board using Fuse and K8055fs

VERSION ^

Version 0.96

ABSTRACT ^

Device::Velleman::K8055::Fuse provides an object-oriented API to the k8055fs Fuse-based interface to the Velleman K8055 USB Experimental Interface Board.

Using the module, it is possible to set two 5v analog output ports, read from two 5v analog input boards, read from a 5-bit digital input stream, write to an 8-bit digital output stream, and set two digital counters with configurable gate times.

SYNOPSIS ^

    use Device::Velleman::K8055::Fuse
        my $dev = new(pathToDevice=>'/path/to/device','debug'=>1);

    
    # let us flicker the Analog output leds three times each
    for (my $i = 0; $i < 3; $i++)
    {
        for (my $j = 1; $j < 3; $j++)
        {
            $dev->SetAnalogChannel($j);
            $dev->ClearAnalogChannel($j == 1 ? 2 : ($j -1));
            sleep(1);
        }
    }
    # clear the analog output
    $dev->ClearAllAnalog();

In order to work with this module, the k8055fs utility must be installed. This utility relies on Fuse, which must also be installed.

new()

The constructor. Buils the object.

Example:

New object with k8055 card initialisation

    my $dev = Device::Velleman::K8055::Fuse->new(
        initDevice => { -U => 0, pathToDevice => '/tmp/k8055', -b => 2, test => 1 },
        debug   => 1
    ) || die "Failed to get an object $!";

New object using initialized k8055 card

    my $dev = Device::Velleman::K8055::Fuse->new(
        pathToDevice => '/tmp/8055',
        debug   => 1,
    ) || die "Failed to get an object $!";

Inputs

(optional) initDevice: hash reference containing the inputs expected by InitialiseDevice. Refer to method documentation below for input specifications. If initDevice exists, then method InitialseDevice is called inside the constructor.

debug = 0 / 1 : Debug flag for outputing debugging information

pathToDevice : the name of the path where the k8055fs commands are mounted.

Returns the object on success

testHarness = 0/1 : Use a test harness rather than the card itself. This allows debugging of the applicaiton logic without relying on the hardware itself being present.

When the test harness is activated, option test => 1 is automatically passed to the InitialiseDevice method.

Furthermore, any Set functionality returns the set value or array of the value, as relevant. Any get function returns -1.

ReadAnalogChannel();

 my $val1 = $dev->ReadAnalogChannel(1);
 my $val2 = $dev->ReadAnalogChannel(2);

 my $channel = 1;
 my $val3 = $dev->ReadAnalogChannel($channel);

Reads the value from the analog channel indicated by (1 or 2). The input voltage of the selected 8-bit Analogue to Digital converter channel is converted to a value which lies between 0 and 255.

Returns the numeric value.

ReadAllAnalog();

 my ($val1,$val2) = $dev->ReadAllAnalog();

ReadAllAnalog reads the values from the two analog ports into $data1 and $data2.

Inputs: None

Outputs: array of two numeric values

OutputAnalogChannel();

 my $val = $dev->OutputAnalogChannel(1,0);
 my $val = $dev->OutputAnalogChannel(2,255);

This outputs $value to the analog channel indicated by $channel.

The indicated 8-bit Digital to Analogue Converter channel is altered according to the new value. This means that the value corresponds to a specific voltage. The value 0 corresponds to a minimum output voltage (0 Volt) and the value 255 corresponds to a maximum output voltage (+5V). A value of $value lying in between these extremes can be translated by the following formula : $value / 255 * 5V.

See also SetAnalogChannel() and SetAllAnalog()

OutputAllAnalog();

 my ($val1,$val2) = $dev->OutputAllAnalog(0,255);

 my $val = $dev->OutputAllAnalog(255);

This outputs $value1 to the first analog channel, and $value2 to the second analog channel. If only one argument is passed, then both channels are given the same value.

See also: SetAllAnalog()

ClearAnalogChannel();

This clears the analog channel indicated by $channel. The selected DA-channel is set to minimum output voltage (0 Volt).

Input: channel number

Output: value between 0 (min) and 255 (max)

 my $dev->ClearAnalogChannel(1);
 my $dev->ClearAnalogChannel(2);

See also OutputAnalogChannel(), ClearAllAnalog()

ClearAllAnalog();

The two DA-channels are set to the minimum output voltage (0 volt).

Returns 0 on success. returns undef if either of the analog channels failed.

 my $dev->ClearAllAnalog();

SetAnalogChannel();

Sets the selected 8-bit Digital output, which in turns sets the DAC voltage. Returns the set value (255) corresponding to this voltage.

 my $channel = 1;
 my $val = $dev->SetAllAnalog($channel);

SetAllAnalog();

The two DA-channels are set to the maximum output voltage. Returns 255 on success. returns undef if either of the analog channels failed.

 my $val = $dev->SetAllAnalog();

WriteAllDigital();

The channels of the digital output port are updated with the status of the corresponding bits in the $value parameter. A high (1) level means that the microcontroller IC1 output is set, and a low (0) level means that the output is cleared.

$value is a decimal value between 0 and 255 that is sent to the output port (8 channels).

 # set all 8 digital outputs to 1.
 my $val = 1;
 $res = $dev->WriteAllDigital($val);

Returns the value on success, returns undef on error.

ClearDigitalChannel();

This clears the digital output channel $channel, which can have a value between 1 and 8 that corresponds to the output channel that is to be cleared.

This is the opposite of SetDigitalChannel.

 # set digital channel 3  to 0
 $res = $dev->ClearDigitalChannel(3);

Returns 0 on success, undef on error.

ClearAllDigital();

This clears (sets to 0) all digital output channels.

 # set all digital channels  to 0
 $res = $dev->ClearAllDigital();

Returns 0 on success, undef on error.

SetDigitalChannel();

This sets the digital output channel $channel, which can have a value between 1 and 8 that corresponds to the output channel that is to be cleared.

This is the opposite of ClearDigitalChannel.

 # set digital channel 3  to 1
 $res = $dev->SetDigitalChannel(3);

AssignDigitalChannel();

This assigns a value todigital channel $channel to the assigned value.

 # set digital channel $channel to binary value $value
 $res = $dev->AssignDigitalChannel($channel,$value);
 
 # set digital channel 3  to 1
 $res = $dev->AssignDigitalChannel(3,1);

 # set digital channel 5  to 0
 $res = $dev->AssignDigitalChannel(5,0);

SetAllDigital();

This sets all digital output channels to 1 (true).

 # set digital channels to 1
 $res = $dev->SetAllDigital();

sets all digital output channels to 1, giving '1111111'.

ReadAllDigital()

This reads all 5 digital ports at once. The 5 least significant bits correspond to the status of the input channels. A high (1) means that the channel is set, a low (0) means that the channel is cleared. Returns the decimal value of the the 8-channel interface card (0-255) unless flag 'bin' is set.

If input contains one string with content 'bin' , then returns an array of binary characters (0/1).

 # Get the value of all digital input channels as an array of binary values in big-endian order 
 $res = $dev->ReadAllDigital();

 # Get the value of all digital input channels as a decimal value
 $res = $dev->ReadAllDigital('dec');

Returns undef on error.

ReadDigitalChannel();

The status of the selected input $channel is read.

$channel can have a value between 1 and 8 which corresponds to the input channel whose status is to be read.

The return value will be true (1) if the channel has been set, false (0) otherwise

returns undef on error.

 # Get the value of a digital input channel
 $res = $dev->ReadDigitalChannel(1);

Note: on the K8055, the addresses of digital inputs 1-5 are not the equivalent binary values.

Refer to the hash $dev->{I} giving the mappings between the card digital input number I and equivalent decimal and binary value, and bit number. $dev->{I} is defined in the constructor.

 $dev->{I} = {

        #decimal value vs I-number
        i2d => {
            1 => 16,
            2 => 32,
            3 => 1,
            4 => 64,
            5 => 128,
        },

        #binary value vs I-number
        i2b => {
            1 => '10000',
            2 => '100000',
            3 => '1',
            4 => '1000000',
            5 => '10000000'
        },

        #bit number (0-7) value vs I-number
        i2i => {
            1 => '4',
            2 => '5',
            3 => '0',
            4 => '6',
            5 => '7',
        }

ReadCounter();

The function returns the status of the selected 16 bit pulse counter. The counter number 1 counts the pulses fed to the input I1 and the counter number 2 counts the pulses fed to the input I2.

returns an 16 bit count on success.

returns undef on error.

 my $count = $dev->ReadCounter(1);
 my $count = $dev->ReadCounter(2);

ResetCounter();

This resets the selected pulse counter.

returns undef on error.

 $my val = $dev->ResetCounter(1);
 $my val = $dev->ResetCounter(2);

SetCounterDebounceTime();

The counter inputs are debounced in the software to prevent false triggering when mechanical switches or relay inputs are used. The debounce time is equal for both falling and rising edges. The default debounce time is 2ms. This means the counter input must be stable for at least 2ms before it is recognised, giving the maximum count rate of about 200 counts per second. If the debounce time is set to 0, then the maximum counting rate is about 2000 counts per second.

The $deboucetime value corresponds to the debounce time in milliseconds (ms) to be set for the pulse counter. Debounce time value may vary between 0 and 5000.

returns the set time in milliseconds on success.

returns undef on error.

 #set the debounce time for counter 2 to 500ms 
 $my time = $dev->SetCounterDebounceTime(2,500);

 #set the debounce time for counter 1 to 2 seconds
 $my time = $dev->SetCounterDebounceTime(1,2000);

get()

uses IO::File to retrieve data from the FUSE files. Refer to the k8055fs readme for details.

  my $res = $dev->get('digital_in',255);
  my $res = $dev->get('analog_in1',255);
  my $res = $dev->get('analog_in2',255);
  my $res = $dev->get('counter1',255);
  my $res = $dev->get('counter2',255);

This is a low-level call that is not particualrly intended for direct access from the API.

The path to the command is defined by hash key pathToDevice in the constructor.

Returns $value on success and undef on error.

set($file,$value)

uses IO::File to send io to the FUSE files. Refer to the k8055fs readme for details.

  my $res = $dev->set('digital_out',255);
  my $res = $dev->set('analog_out1',255);
  my $res = $dev->set('debounce1',255);
  my $res = $dev->set('debounce2',255);

This is a low-level call that is not particualrly intended for direct access from the API. Using the set function could desynchronize the internal representation for the binary array held in array

  $dev->{binary_out}

The path to the command is defined by hash key pathToDevice in the constructor.

Returns $value on success and undef on error.

dec2bin($dec)

convert a decimal to a string representing a bin

The binary string is represented as a big-endian. In big-endian encoding, digits increase as the string progresses to the left:

   0 (dec) =        0 (bin).
   1 (dec) =        1 (bin).
   2 (dec) =       10 (bin).
   3 (dec) =       11 (bin).
   4 (dec) =      100 (bin).
 255 (dec) = 11111111 (bin).

bin2dec($bin)

convert a string representing a binary number to a decimal number.

Refer to dec2bin for information on the binary format in use.

InitDevice (\%args)

Initialises the k8055 USB device by mounting the k8055 file system.

usage: $dev->InitialseDevice({-U=>1, -b=>2, pathToDevice=>'/tmp/8055'})

Input arguments

-b board number. (2-4) If skipped, default board (1) number is taken.

-U 1 0r 0 turn on USB debugging if true.

pathToDevice: Desired mount point of the k8055fs application. This directory needs to be accessible by the user.

fuseOptions: additional options to pass to FUSE.

test: do not run the k8055fs initialiaation. Print the command to STDOUT and return success. This is for debugging support.

See also new().

AUTHOR ^

Ronan Oger, <ronan@cpan.org>

ACKNOWLEDGEMENTS ^

Special thanks to Jouke Visser, author of Device::Velleman::K8055 for writing the original win32-based module. I extensively copied his documentation and derived the method names from the names used by Jouke.

BUGS ^

Likely to be many, please use http://rt.cpan.org/ for reporting bugs. The counter functionality is poorly tested and I suspect it has bugs.

SEE ALSO ^

For more information on this board, visit http://www.velleman.be.

For more information on the K0855fs fuse implementation of K0855, visit https://launchpad.net/k8055fs

For more information on the Fuse driver, visit the FUSE project on sourceforge: http://fuse.sourceforge.net

For Win32 applications, see Jouke Visser's Device::Velleman::K8055 implementation.

COPYRIGHT & LICENSE ^

Copyright 2008 Ronan Oger, All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: