NAME

k8055m_set_report_interval, k8055m_set_min_report_interval, k8055m_get_min_report_interval, k8055m_set_max_report_interval, k8055m_get_max_report_interval -- Set/get minimum and maximum HID report interval

LIBRARY

k8055-pic18f access library

SYNOPSIS

#include "k8055m.h"

int
k8055m_set_report_interval(int cardNumber, int msMin, int msMax);

int
k8055m_get_report_interval(int cardNumber, int *msMin, int *msMax);
    

DESCRIPTION

The k8055-pic18f uses a variable speed HID report interval. It will report the status of input ports rapidly if ports have changed, and it will slow down if there was nothing to report.

This behavior is controlled with two parameters, the minimum and maximum report interval. Under no circumstances will the card send HID reports faster than the minimum interval, which defaults to 1 millisecond. If the minimum interval has elapsed already, the card will send a report within 1 millisecond of any change of an input port. Even if no input port changes at all, the card will send an HID report after the maximum interval has elapsed, which defaults to 10 milliseconds.

Both parameters are measured in milliseconds and must be in the range of 1 .. 5000.

RETURN VALUES

k8055m_set_report_interval and k8055m_get_report_interval return 0 on success, -1 on error. k8055m_get_report_interval will store the current settings into variables pointed to by msMin and msMax.