1.. -*- coding: utf-8; mode: rst -*-
2
3.. _lirc_set_rec_carrier_range:
4
5********************************
6ioctl LIRC_SET_REC_CARRIER_RANGE
7********************************
8
9Name
10====
11
12LIRC_SET_REC_CARRIER_RANGE - Set lower bound of the carrier used to modulate
13IR receive.
14
15Synopsis
16========
17
18.. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency )
19    :name: LIRC_SET_REC_CARRIER_RANGE
20
21Arguments
22=========
23
24``fd``
25    File descriptor returned by open().
26
27``frequency``
28    Frequency of the carrier that modulates PWM data, in Hz.
29
30Description
31===========
32
33This ioctl sets the upper range of carrier frequency that will be recognized
34by the IR receiver.
35
36.. note::
37
38   To set a range use :ref:`LIRC_SET_REC_CARRIER_RANGE
39   <LIRC_SET_REC_CARRIER_RANGE>` with the lower bound first and later call
40   :ref:`LIRC_SET_REC_CARRIER <LIRC_SET_REC_CARRIER>` with the upper bound.
41
42Return Value
43============
44
45On success 0 is returned, on error -1 and the ``errno`` variable is set
46appropriately. The generic error codes are described at the
47:ref:`Generic Error Codes <gen-errors>` chapter.
48