lirc-set-rec-carrier-range.rst 1.1 KB

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