21742bd2ec
- Added missing man pages for the new functions. - Updated the main libdivecomputer man page to reflect the new flow. - Fixed minor typos in the dc_parser_get_field and dc_parser_samples_foreach functions.
85 lines
2.2 KiB
Groff
85 lines
2.2 KiB
Groff
.\"
|
|
.\" libdivecomputer
|
|
.\"
|
|
.\" Copyright (C) 2020 Vincent Hagen <vinnie@script4web.nl>
|
|
.\"
|
|
.\" This library is free software; you can redistribute it and/or
|
|
.\" modify it under the terms of the GNU Lesser General Public
|
|
.\" License as published by the Free Software Foundation; either
|
|
.\" version 2.1 of the License, or (at your option) any later version.
|
|
.\"
|
|
.\" This library is distributed in the hope that it will be useful,
|
|
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
.\" Lesser General Public License for more details.
|
|
.\"
|
|
.\" You should have received a copy of the GNU Lesser General Public
|
|
.\" License along with this library; if not, write to the Free Software
|
|
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
.\" MA 02110-1301 USA
|
|
.\"
|
|
.Dd June 5, 2020
|
|
.Dt DC_IRDA_OPEN 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm dc_irda_open
|
|
.Nd Opens an iostream for a IrDA device
|
|
.Sh LIBRARY
|
|
.Lb libdivecomputer
|
|
.Sh SYNOPSIS
|
|
.In libdivecomputer/irda.h
|
|
.Ft dc_status_t
|
|
.Fo dc_irda_open
|
|
.Fa "dc_iostream_t **iostream"
|
|
.Fa "dc_context_t *context"
|
|
.Fa "unsigned int address"
|
|
.Fa "unsigned int lsap"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
Opens an iostream for a IrDA (Infra Red) device.
|
|
Accepts a
|
|
.Fa context
|
|
opened with
|
|
.Xr dc_context_new 3 ,
|
|
.Fa address
|
|
given through
|
|
.Xr dc_irda_iterator_new 3
|
|
together with
|
|
.Xr dc_irda_device_get_address 3
|
|
, the last argument
|
|
.Fa lsap
|
|
is a port number used during the communication. Currently only Uwatec computers use IrDA comminication and for those the
|
|
.Fa lsap
|
|
can be hardcoded to 1
|
|
.Pp
|
|
Upon returning
|
|
.Dv DC_STATUS_SUCCESS ,
|
|
the
|
|
.Fa iostream
|
|
pointer must be freed with
|
|
.Xr dc_iostream_close 3 .
|
|
.Sh RETURN VALUES
|
|
Returns
|
|
.Dv DC_STATUS_SUCCESS
|
|
on success or one of several error values on error.
|
|
On success, the
|
|
.Fa iostream
|
|
pointer is filled in with an open handle.
|
|
.Sh SEE ALSO
|
|
.Xr dc_context_new 3 ,
|
|
.Xr dc_iostream_close 3 ,
|
|
.Xr dc_serial_open 3 ,
|
|
.Xr dc_usbhid_open 3 ,
|
|
.Xr dc_bluetooth_open 3 ,
|
|
.Xr dc_irda_iterator_new 3 ,
|
|
.Xr dc_irda_device_get_address 3 .
|
|
.Sh AUTHORS
|
|
The
|
|
.Lb libdivecomputer
|
|
library was written by
|
|
.An Jef Driesen ,
|
|
.Mt jef@libdivecomputer.org .
|
|
.br
|
|
This manpage is written by
|
|
.An Vincent Hagen ,
|
|
.Mt vinnie@script4web.nl . |