Trigger Configuration

Applicable Devices : RFD40, RFD90, RFD8500

Overview

Gets and sets the start and stop trigger parameters of an active RFID reader, using srfidGetStartTriggerConfiguration and srfidSetStartTriggerConfiguration for the start trigger and srfidGetStopTriggerConfiguration and srfidSetStopTriggerConfiguration for the stop trigger.

Details

The SDK provides an ability to configure start and stop trigger parameters. Start trigger parameters include the following:

  • Start of an operation based on a physical trigger
  • Trigger type (press/release) of a physical trigger
  • Delay (in milliseconds) of start of operation
  • Repeat monitoring for start trigger after stop of operation

Start trigger configuration could be retrieved and set via srfidGetStartTriggerConfiguration and srfidSetStartTriggerConfiguration API functions accordingly.

Stop trigger parameters include the following:

  • Stop of an operation based on a physical trigger
  • Trigger type (press/release) of a physical trigger
  • Stop of an operation based on a specified number of tags inventoried
  • Stop of an operation based on a specified timeout (in milliseconds)
  • Stop of an operation based on a specified number of inventory rounds completed
  • Stop of an operation based on a specified number of access rounds completed

Stop trigger settings could be retrieved and set via srfidGetStopTriggerConfiguration and srfidSetStopTriggerConfiguration API functions accordingly.

The following examples demonstrate retrieval of current start and stop trigger parameters as well as configuring new start and stop triggers parameters.

Get Start Trigger Configuration

The getStartTrigger method retrieves the current start trigger parameters and prints them.


-(void)getStartTrigger{
    /* allocate object for storage of start trigger settings */
    srfidStartTriggerConfig *start_trigger_cfg = [[srfidStartTriggerConfig alloc] init];
    /* an object for storage of error response received from RFID reader */
    NSString *error_response = nil;
    /* retrieve start trigger parameters */
    SRFID_RESULT result = [apiInstance srfidGetStartTriggerConfiguration:readerID aStartTriggeConfig:&start_trigger_cfg aStatusMessage:&error_response];

    if (SRFID_RESULT_SUCCESS == result)
    {
        /* start trigger configuration received */
        NSLog(@"Start trigger: start on physical trigger = %@\n", ((YES == [start_trigger_cfg getStartOnHandheldTrigger]) ? @"YES" : @"NO"));
        NSLog(@"Start trigger: physical trigger type = %@\n", ((SRFID_TRIGGERTYPE_PRESS == [start_trigger_cfg getTriggerType]) ? @"PRESSED" : @"RELEASED"));
        NSLog(@"Start trigger: delay = %d ms\n", [start_trigger_cfg getStartDelay]);
        NSLog(@"Start trigger: repeat monitoring = %@\n", ((NO == [start_trigger_cfg getRepeatMonitoring]) ? @"NO" : @"YES"));
    }
    else
    {
        NSLog(@"Failed to receive start trigger parameters\n");
    }
}

Get Stop Trigger Configuration

The getStopTrigger method retrieves the current stop trigger parameters and prints them.


-(void)getStopTrigger
{
    NSString *error_response = nil;
    /* allocate object for storage of stop trigger settings */
    srfidStopTriggerConfig *stop_trigger_cfg = [[srfidStopTriggerConfig alloc] init];
    /* retrieve stop trigger parameters */
    SRFID_RESULT result = [apiInstance srfidGetStopTriggerConfiguration:readerID aStopTriggeConfig:&stop_trigger_cfg aStatusMessage:&error_response];

    if (SRFID_RESULT_SUCCESS == result)
    {
        /* stop trigger configuration received */
        NSLog(@"Stop trigger: stop on physical trigger = %@\n", ((YES == [stop_trigger_cfg getStopOnHandheldTrigger]) ? @"YES" : @"NO"));
        NSLog(@"Stop trigger: physical trigger type = %@\n", ((SRFID_TRIGGERTYPE_PRESS == [stop_trigger_cfg getTriggerType]) ? @"PRESSED" : @"RELEASED"));

        if (YES == [stop_trigger_cfg getStopOnTagCount])
        {
            NSLog(@"Stop trigger: stop on %d number of tags received\n", [stop_trigger_cfg getStopTagCount]);
        }

        if (YES == [stop_trigger_cfg getStopOnTimeout])
        {
            NSLog(@"Stop trigger: stop on %d ms timeout\n", [stop_trigger_cfg getStopTimeout]);
        }

        if (YES == [stop_trigger_cfg getStopOnInventoryCount])
        {
            NSLog(@"Stop trigger: stop on %d inventory rounds\n", [stop_trigger_cfg getStopInventoryCount]);
        }

        if (YES == [stop_trigger_cfg getStopOnAccessCount])
        {
            NSLog(@"Stop trigger: stop on %d access rounds\n", [stop_trigger_cfg getStopAccessCount]);
        }
    }
    else
    {
        NSLog(@"Failed to receive stop trigger parameters\n");
    }
  }

Set Stop Trigger Configuration

The setStopTrigger method configures new stop trigger parameters.


-(void)setStopTrigger {
    /* allocate object for storage of stop trigger settings */
    srfidStopTriggerConfig *stop_trigger_cfg = [[srfidStopTriggerConfig alloc] init];
    /* an object for storage of error response received from RFID reader */
    NSString *error_response = nil;
    /* stop on physical trigger */
    [stop_trigger_cfg setStopOnHandheldTrigger:YES];
    [stop_trigger_cfg setTriggerType:SRFID_TRIGGERTYPE_RELEASE];
    [stop_trigger_cfg setStopOnTimeout:YES];
    [stop_trigger_cfg setStopTimout:(5*1000)];
    [stop_trigger_cfg setStopOnTagCount:YES];
    [stop_trigger_cfg setStopTagCount:10];
    [stop_trigger_cfg setStopOnInventoryCount:NO];
    [stop_trigger_cfg setStopOnAccessCount:NO];

    /* set stop trigger parameters */
    SRFID_RESULT result = [apiInstance srfidSetStopTriggerConfiguration:readerID aStopTriggeConfig:stop_trigger_cfg aStatusMessage:&error_response];
    if (SRFID_RESULT_SUCCESS == result)
    {
        /* stop trigger configuration applied */
        NSLog(@"Stop trigger configuration has been set\n");
    }
    else
    {
      NSLog(@"Failed to set stop trigger parameters\n");
    }
}

Set Start Trigger Configuration

The setStartTrigger method configures new start trigger parameters.


-(void)setStartTrigger {

    /* allocate object for storage of start trigger settings */
    srfidStartTriggerConfig *start_trigger_cfg = [[srfidStartTriggerConfig alloc] init];
    /* an object for storage of error response received from RFID reader */
    NSString *error_response = nil;
    /* configure start trigger parameters */
    /* start on physical trigger */
    [start_trigger_cfg setStartOnHandheldTrigger:YES];
    /* start on physical trigger press */
    [start_trigger_cfg setTriggerType:SRFID_TRIGGERTYPE_PRESS];
    /* repeat monitoring for start trigger conditions after operation stop */
    [start_trigger_cfg setRepeatMonitoring:YES];
    [start_trigger_cfg setStartDelay:0];
    /* set start trigger parameters */
    SRFID_RESULT result = [apiInstance srfidSetStartTriggerConfiguration:readerID aStartTriggeConfig:start_trigger_cfg aStatusMessage:&error_response];

    if (SRFID_RESULT_SUCCESS == result)
    {
        /* start trigger configuration applied */
        NSLog(@"Start trigger configuration has been set\n");
    }
    else
    {
        NSLog(@"Failed to set start trigger parameters\n");
    }
}