[[TOC(heading=Table of Contents, Docs/Prog/Manual/*)]]

== DIO ==

=== DIO Events ===

==== About ====
This document will guide the programmer through the process of creating and using a simple DIO Event using the DioEvent class provided in the standard library (lib825). DIO Events are processed by the mainboard in order to allow a level of redundancy. Should the OPI board kernel crash the mainboard will continue to provide relay functionality and will disable events when their thresholds are reached.

==== The Code ====
To use a DIO event follow the example code below.

{{{
#!Lineno
#!c

// required include file from lib825
#include "DioEvent.h"

int main() {
  // indicator startup (open mainboard, etc)

  // dio example
  DioEvent event;

  int scale = 1;
  int board = 0;
  int pin = 0x01;
  float fTarget = 250.00;

  // set up the event
  int myEvent = event.addEvent(scale,EVENT_GROSS,EVENT_LESS,fTarget,board,pin);

  // optionally add a conditional statement to it
  event.addCondition(myEvent,scale,EVENT_GROSS,EVENT_GREATER,0,EVENT_AND);

  // start the individual event 
  event.startEvent(myEvent);

  // OR you can start all events
  event.startAll();

  // indicator shutdown (close mainboard, etc)
  return 0;
}
}}}

The above code would create an event that would enable board 0 (mainboard) pin 0 when the gross weight of scale 1 is less than 250.00 and greater than 0.00.

=== DIO Counting ===

==== Description ====

Mainboard software 1.15 is required for counting feature. Kernel 2009-10-07 or later is required. All four inputs of the mainboard may be used for counting. The DIO cards allow any one of inputs 1 - 7 to be used for counting. Input 8 may also be used for counting. This allows for up to two inputs per DIO card to be used for counting.

==== Example ====

{{{
#!Lineno
#!c

#include <stdio.h>
#include <stdlib.h>

#include "kypdbeep.h"
#include "lcd.h"
#include "mnbdcomm.h"

extern uint16 g_dio_count;

extern int g_keycnt;

extern uint8 g_keybuf[KEYBUF_SIZE];
extern struct set_dio_struct mnbd_set_dio;

int main() {

	char szCnt[41];

	struct timespec delaytm;
	delaytm.tv_sec = 0;
	delaytm.tv_nsec = 1000000;  // 1 ms

	InitLCD();
	ClearLCD();

	OpenBeeper();

	PrintLCD("DIO Counter Test\r");
	PrintLCD("Press '1' - '4' to toggle outputs");

	int input;

	// Note - all four input pins of mainboard may be used for counting, options card may use only one of inputs 1 - 7 for
	// counting and input 8 may always be used for counting.

	OpenMnBd(MNBD_DEV);

	struct {
		int init_cnt;
		int prescaler;
		DIOSetReg up_or_down;
		DIOSetReg low_or_high;
	} test[4] = {
			// Experiment with different options to observe different counter behavior
			//  Count  Prescaler    Count Up or down    Count on low to high, or high to low
			{ 		0,  	1, 		dioSetCountUp, 		dioSetCountLowToHigh },
			{ 	   10, 		1,		dioSetCountDown, 	dioSetCountLowToHigh },
			{ 		0, 		1, 		dioSetCountUp, 		dioSetCountHighToLow },
			{ 	  100, 		2, 		dioSetCountDown, 	dioSetCountLowToHigh }
	};

	for(input = 1; input <= 4; input++)
	{
		if(SetDIOCounter(MNBD_DEV, input, dioSetCount, test[input-1].init_cnt, WAIT_ACK) != MNBD_REQ_ACK_RCVD)
		{
			PrintLCD("Cannot set count\r");
		}

		if(SetDIOCounter(MNBD_DEV, input, dioSetPrescaler, test[input-1].prescaler, WAIT_ACK) != MNBD_REQ_ACK_RCVD)
		{
			PrintLCD("Cannot set prescaler\r");
		}

		if(SetDIOCounter(MNBD_DEV, input, test[input-1].up_or_down, 0, WAIT_ACK) != MNBD_REQ_ACK_RCVD)
		{
			PrintLCD("Cannot set count up\r");
		}

		if(SetDIOCounter(MNBD_DEV, input, test[input-1].low_or_high, 0, WAIT_ACK) != MNBD_REQ_ACK_RCVD)
		{
			PrintLCD("Cannot set count low to high\r");
		}

		if(SetDIOCounter(MNBD_DEV, input, dioEnableCounter, 0, WAIT_ACK) != MNBD_REQ_ACK_RCVD)
		{
			PrintLCD("Cannot enable counter\r");
		}
	}

	input = 1;

	mnbd_set_dio.output = 0;

	int req_cnt = 3000;
	int n;
	GetDIOCounter(MNBD_DEV, input, dioGetCount, NO_WAIT_ACK);

	while(1)
	{
		ReadKeypad();
		if(g_keycnt > 0)
		{
			g_keycnt = 0;
			if(g_keybuf[0] == ESC)
				break;
			// Keypad keys "1" through "4" will toggle state of output which is looped back to input
			// so that we can observe operation of counter
			if(g_keybuf[0] >= '1' && g_keybuf[0] <= '4')
			{
				mnbd_set_dio.mask = 0x000F;
				n = g_keybuf[0] - '1';
				if(mnbd_set_dio.output & (1 << n))
				{
					mnbd_set_dio.output &= ~(1 << n);
					LocateLCD(n * FONT_WIDTH * 10, FONT_HEIGHT * 3);
					PrintLCD("  ");
				}
				else
				{
					mnbd_set_dio.output |= (1 << n);
					LocateLCD(n * FONT_WIDTH * 10, FONT_HEIGHT * 3);
					PrintLCD("on");
				}

				MnBdRequest(MNBD_DEV, MNBD_REQ_SET_IO_STATUS, WAIT_ACK);
				nanosleep(&delaytm, NULL);

				input = n + 1;
				req_cnt = 1;
			}
		}

		req_cnt--;
		if(req_cnt == 0)
		{
			GetDIOCounter(MNBD_DEV, input, dioGetCount, NO_WAIT_ACK);
			req_cnt = 3000;
		}

		nanosleep(&delaytm, NULL);

		if(CheckDIOCountRcv(MNBD_DEV))
		{
			sprintf(szCnt, "%6d", g_dio_count);
			LocateLCD((input - 1) * FONT_WIDTH * 10, FONT_HEIGHT * 2);
			PrintLCD(szCnt);

			if(input == 4)
				input = 1;
			else
				input++;

			req_cnt = 5;
		}
	}

	// Done - disable the counters
	for(input = 1; input <= 4; input++)
	{
		if(SetDIOCounter(MNBD_DEV, input, dioDisableCounter, 0, WAIT_ACK) != MNBD_REQ_ACK_RCVD)
		{
			PrintLCD("Cannot disable counter\r");
		}
	}

	CloseMnBd(MNBD_DEV);

	ClearLCD();

	return 0;
}


}}}

== USB Support ==
The [wiki:WikiStart Cardinal 825] supports many USB devices such as Flash Drives, Printers (Cardinal supported only!), keyboards, and mice.

=== USB Mass Storage ===
The 825 supports USB flash storage devices formatted with the FAT (file allocation table) and FAT32 file systems. From the serial command line when a USB storage device is inserted the display will appear similar to:

[[Image(usb_insert.jpg)]]

Use the mount command to access files on the USB flash drive:

{{{
mount –t vfat /dev/sda1 /mnt/fl1
}}}
The files will then appear in the path /mnt/fl1 such as:

[[Image(usb_mount.jpg)]]

The file manager may be used to access USB flash drives. When the /mnt/fl1 folder is selected the file manager will automatically perform the mount command.

[[Top]]

=== USB Keyboards ===
As of kernel 2008-11-13 many USB keyboards should work with the 825. Simply plug the keyboard into an 825 USB connection.

[[Image(usb_keyboard.jpg)]]

Applications using the lib825 functions such as [[lib825:source:trunk/kypdbeep.cpp#L78 ReadKeypad]] or [[lib825:source:trunk/form.cpp#L1027 FormLCD] will automatically work with the USB keyboard. To test the keyboard without any app running type some characters on the keyboard and type:

{{{
# cat /dev/usbkybd
}}}
Output:

[[Image(usb_keyboard_test.jpg)]]

The characters typed on the USB keyboard should show on the serial port terminal.

[[Top]]

=== USB Printing ===
usblp.ko device driver module for usb printing support. Type:

{{{
# modprobe usblp
}}}
Kernel should be configured with /dev/usblp0 device node. If not type:

{{{
# mknod /tmp/usblp0 c 180 0
}}}
''/dev is in read-only file system so device node can be created under /tmp instead''

This creates the character device driver with major number 180 and minor number 0. This should work unmodified with USB printers that accept raw text for printing using a default font.

A simple test is:

{{{
# echo “ABCDEFGH” > /dev/usblp0
'''or'''
# echo “ABCDEFGH” > /tmp/usblp0
}}}
''Applications may be written to open “/dev/usblp0” to print to USB printer 0 instead of “/dev/ttyS1” to open COM2''

==== Successful Tests ====
 * Okidata Microline 320 Turbo - ''Older versions of this printer do not have USB port''
 * Hewlett Packard !DeskJet 830C - ''Does not print page until filled so extra line feeds are required to fill the page to finish the print''

==== Currently Developing ====
 * HP !LaserJet P1020

==== Unsuccessful ====
 * HP !LaserJet P1006 - ''Research indicates this printer requires host to send firmware update file to printer, and does not accept raw text but requires XQX stream protocol''

[[Top]]

=== USB to PC communications ===
To load the driver for USB to PC communications type:

{{{
# modprobe g_serial use_acm=1
}}}
When the 825 is connected to the PC it will be recognized by the PC and if the driver is not already installed it will prompt for it. Refer to “gadget_serial.txt”

When the driver is installed the PC will appear to have another COM port. For testing on the PC you can then open a communications program such as HyperTerminal and set it to the appropriate COM port (which is actually a USB connection).

On the serial connection to the indicator type:

{{{
# echo “abcdefg” > /dev/ttygserial
}}}
“abcdefg” will then appear on the Hyperterm display.

In HyperTerminal, type:

{{{
123456
}}}
On the serial connection to the indicator type:

{{{
# cat < /dev/ttygserial
}}}
The received characters “123456” from the PC will then be displayed.

[[Top]]