Tag Report Configuration

Applicable Devices : RFD40, RFD90, RFD8500

Overview

Gets and sets the fields an active RFID reader reports in response to an operation, using srfidGetTagReportConfiguration and srfidSetTagReportConfiguration.

Details

The SDK provides an ability to configure a set of fields to be reported in a response to an operation by a particular active RFID reader. Supported fields that might be reported include the following:

  • First and last seen times
  • PC value
  • RSSI value
  • Phase value
  • Channel index
  • Tag seen count

Tag report parameters could be managed via srfidSetTagReportConfiguration and srfidGetTagReportConfiguration API functions as demonstrated in the following examples.

Get Tag Report Configuration

The getTagReportConfig method retrieves the current tag report settings and prints them.


-(void)getTagReportConfig {
    /* allocate object for storage of tag report settings */
    srfidTagReportConfig *report_cfg = [[srfidTagReportConfig alloc] init];
    /* an object for storage of error response received from RFID reader */
    NSString *error_response = nil;
    /* retrieve tag report parameters */
    SRFID_RESULT result = [apiInstance srfidGetTagReportConfiguration:readerID aTagReportConfig:&report_cfg aStatusMessage:&error_response];

    if (SRFID_RESULT_SUCCESS == result)
    {
        /* tag report configuration received */
        NSLog(@"PC field: %@\n", ((NO == [report_cfg getIncPC]) ? @"off" : @"on"));
        NSLog(@"Phase field: %@\n", ((NO == [report_cfg getIncPhase]) ? @"off" : @"on"));
        NSLog(@"Channel index field: %@\n", ((NO == [report_cfg getIncChannelIdx]) ? @"off" : @"on"));
        NSLog(@"RSSI field: %@\n", ((NO == [report_cfg getIncRSSI]) ? @"off" : @"on"));
        NSLog(@"Tag seen count field: %@\n", ((NO == [report_cfg getIncTagSeenCount]) ? @"off" : @"on"));
        NSLog(@"First seen time field: %@\n", ((NO == [report_cfg getIncFirstSeenTime]) ? @"off" : @"on"));
        NSLog(@"Last seen time field: %@\n", ((NO == [report_cfg getIncLastSeenTime]) ? @"off" : @"on"));
    }
    else
    {
        NSLog(@"Failed to receive tag report parameters\n");
    }
}

Set Tag Report Configuration

The setTagReportConfig method applies new tag report settings.


-(void)setTagReportConfig {
    /* allocate object for storage of tag report settings */
    srfidTagReportConfig *report_cfg = [[srfidTagReportConfig alloc] init];
    /* an object for storage of error response received from RFID reader */
    NSString *error_response = nil;
    /* configure tag report parameters to include only RSSI field */
    [report_cfg setIncRSSI:YES];
    [report_cfg setIncPC:NO];
    [report_cfg setIncPhase:NO];
    [report_cfg setIncChannelIndex:NO];
    [report_cfg setIncTagSeenCount:NO];
    [report_cfg setIncFirstSeenTime:NO];
    [report_cfg setIncLastSeenTime:NO];

    /* set tag report parameters */
    SRFID_RESULT result = [apiInstance srfidSetTagReportConfiguration:readerID aTagReportConfig:report_cfg aStatusMessage:&error_response];
    if (SRFID_RESULT_SUCCESS == result)
    {
        /* tag report configuration applied */
        NSLog(@"Tag report configuration has been set\n");
    }
    else
    {
        NSLog(@"Failed to set tag report parameters\n");
    }
}