gPhoto2

http://www.gphoto.org/doc/
Admin
gPhoto2 is a free, open-source software that allows users to download photos from digital cameras...
Tokens:189,158
Snippets:2,041
Trust Score:5.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### --config

Source: http://www.gphoto.org/doc/manual/ref-gphoto2-cli.html

Starts a ncurses based text configuration menu.

```APIDOC
## --config

### Description
Starts a ncurses based text configuration menu. gphoto2 needs to built against CDK for this feature.
```

--------------------------------

### Camera Initialization and Setup

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8h.html

Functions for initializing and configuring camera devices.

```APIDOC
## gp_camera_new

### Description
Prepares for camera initialization.

### Signature
int gp_camera_new(Camera **camera)

```

```APIDOC
## gp_camera_set_abilities

### Description
Sets the camera abilities.

### Signature
int gp_camera_set_abilities(Camera *camera, CameraAbilities abilities)

```

```APIDOC
## gp_camera_get_abilities

### Description
Gets the camera abilities.

### Signature
int gp_camera_get_abilities(Camera *camera, CameraAbilities *abilities)

```

```APIDOC
## gp_camera_set_port_info

### Description
Sets the camera port information.

### Signature
int gp_camera_set_port_info(Camera *camera, GPPortInfo info)

```

```APIDOC
## gp_camera_get_port_info

### Description
Gets the camera port information.

### Signature
int gp_camera_get_port_info(Camera *camera, GPPortInfo *info)

```

```APIDOC
## gp_camera_set_port_speed

### Description
Sets the camera port speed. Use with caution as it may prevent the driver from selecting optimal speed.

### Signature
int gp_camera_set_port_speed(Camera *camera, int speed)

```

```APIDOC
## gp_camera_get_port_speed

### Description
Gets the camera port speed.

### Signature
int gp_camera_get_port_speed(Camera *camera)

```

```APIDOC
## gp_camera_autodetect

### Description
Autodetects available cameras and populates a CameraList.

### Signature
int gp_camera_autodetect(CameraList *list, GPContext *context)

```

```APIDOC
## gp_camera_init

### Description
Initializes the camera.

### Signature
int gp_camera_init(Camera *camera, GPContext *context)

```

```APIDOC
## gp_camera_exit

### Description
Exits the camera connection.

### Signature
int gp_camera_exit(Camera *camera, GPContext *context)

```

--------------------------------

### --shell

Source: http://www.gphoto.org/doc/manual/ref-gphoto2-cli.html

Start the gphoto2 shell, an interactive environment.

```APIDOC
## --shell

### Description
Start the gphoto2 shell, an interactive environment. See SHELL MODE for a detailed description.
```

--------------------------------

### Example udev script for camera file transfer

Source: http://www.gphoto.org/doc/manual/permissions-usb.html

This is an example shell script intended to be called by udev rules. It handles device addition events, sets ownership and permissions, and then uses gphoto2 to download files from the camera.

```sh
#!/bin/sh
# UNTESTED SCRIPT (but you get the idea)

test "x$ACTION" != "xadd" || exit 0
test "x$SUBSYSTEM" != "xusb_device" || exit 0

if test -e "$DEVNAME"
then
  user="photoripper"
  chown "$user" "$DEVNAME"
  chmod 0600 "$DEVNAME"

  # SUBSYSTEM == "usb_device" implies that DEVNAME == "/dev/bus/usb/123/456"
  # Determine device ID and bus ID.
  dev="$(basename "$DEVNAME")"
  bus="$(basename "$(dirname "$DEVNAME")")"

  # Download all files from that camera to incoming directory with
  # lowercase filenames
  command="/usr/bin/gphoto2 --port usb:${bus},${dev} --get-all-files"
  command="$command --filename /var/local/photodump/incoming/%:"
  echo "Executing command: $command"
  su "$photoripper" -c "$command"
else
  echo "photoripper: Given device named $DEVNAME not found."
  exit 1
fi

```

--------------------------------

### Camera Initialization and Setup

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8h_source.html

Functions for creating, destroying, and configuring camera objects.

```APIDOC
## gp_camera_new

### Description
Creates a new camera instance.

### Parameters
- **camera** (Camera **) - Output parameter to store the new camera instance.

### Returns
Returns 0 on success, a negative errno on failure.
```

```APIDOC
## gp_camera_set_abilities

### Description
Sets the abilities of a camera.

### Parameters
- **camera** (Camera *) - The camera instance.
- **abilities** (CameraAbilities) - The abilities to set.

### Returns
Returns 0 on success, a negative errno on failure.
```

```APIDOC
## gp_camera_get_abilities

### Description
Gets the abilities of a camera.

### Parameters
- **camera** (Camera *) - The camera instance.
- **abilities** (CameraAbilities *) - Output parameter to store the camera abilities.

### Returns
Returns 0 on success, a negative errno on failure.
```

```APIDOC
## gp_camera_set_port_info

### Description
Sets the port information for a camera.

### Parameters
- **camera** (Camera *) - The camera instance.
- **info** (GPPortInfo) - The port information to set.

### Returns
Returns 0 on success, a negative errno on failure.
```

```APIDOC
## gp_camera_get_port_info

### Description
Gets the port information for a camera.

### Parameters
- **camera** (Camera *) - The camera instance.
- **info** (GPPortInfo *) - Output parameter to store the port information.

### Returns
Returns 0 on success, a negative errno on failure.
```

```APIDOC
## gp_camera_set_port_speed

### Description
Sets the port speed for a camera.

### Parameters
- **camera** (Camera *) - The camera instance.
- **speed** (int) - The port speed to set.

### Returns
Returns 0 on success, a negative errno on failure.
```

```APIDOC
## gp_camera_get_port_speed

### Description
Gets the port speed of a camera.

### Parameters
- **camera** (Camera *) - The camera instance.

### Returns
Returns the port speed on success, a negative errno on failure.
```

--------------------------------

### --get-config

Source: http://www.gphoto.org/doc/manual/ref-gphoto2-cli.html

Get the specified configuration entry.

```APIDOC
## --get-config CONFIGENTRY

### Description
Get the specified configuration entry.
This command will list the type, the current value and also the available options of this configuration value.

### Parameters
#### Path Parameters
- **CONFIGENTRY** (string) - Required - The configuration entry to retrieve.
```

--------------------------------

### gp_context_progress_start

Source: http://www.gphoto.org/doc/api/gphoto2-context_8h.html

Starts progress tracking for a given context with a specified target and format string.

```APIDOC
## gp_context_progress_start

### Description
Starts a new progress tracking for a specified context. This allows for nested progress reports.

### Parameters
- **context** (GPContext *) - The context in which to start the progress.
- **target** (float) - The value representing 100% completion.
- **format** (const char *) - A `sprintf`-style format string for the progress message.
- **...** - Variable arguments for the format string.
```

--------------------------------

### gp_context_progress_start

Source: http://www.gphoto.org/doc/api/globals_func_g.html

Starts progress reporting within the context. Source: gphoto2-context.c, gphoto2-context.h

```APIDOC
## gp_context_progress_start()

### Description
Initiates the reporting of progress for an ongoing operation within the context.

### Source
gphoto2-context.c, gphoto2-context.h
```

--------------------------------

### gp_context_progress_start

Source: http://www.gphoto.org/doc/api/gphoto2-context_8c.html

Starts progress tracking within a specified context, allowing for nested progress reports.

```APIDOC
## Function Documentation
unsigned int gp_context_progress_start  | ( | GPContext *  | _context_ ,   float  | _target_ ,   const char *  | _format_ ,   | _..._  
) |

### Description
Starts progress tracking. This function starts up a new progress tracking for a specified context. Several nested progress reports can happen at once, depending on the backend.

### Parameters
- **_context_** (GPContext *) - The context in which to start the progress.
- **_target_** (float) - The value representing 100% completion.
- **_format_** (const char *) - A `sprintf` style string to print out, including variable arguments.
- **...** - Variable arguments for the format string.
```

--------------------------------

### Display Help

Source: http://www.gphoto.org/doc/manual/ref-gphoto2-cli.html

Shows the available commands and their usage.

```bash
help
```

```bash
?
```

--------------------------------

### gphoto2-port.c / gphoto2-port.h Functions

Source: http://www.gphoto.org/doc/api/globals_func_g.html

Functions for port operations, including checking integers, closing ports, flushing, freeing, getting errors/info/settings/timeouts, and getting pin status.

```APIDOC
## gp_port_check_int()

### Description
Checks an integer value related to the port.

### Method
(Not specified, likely a C function call)

### Endpoint
N/A

### Parameters
(Not specified)

### Request Example
N/A

### Response
(Not specified)
```

```APIDOC
## gp_port_check_int_fast()

### Description
Performs a fast check of an integer value related to the port.

### Method
(Not specified, likely a C function call)

### Endpoint
N/A

### Parameters
(Not specified)

### Request Example
N/A

### Response
(Not specified)
```

```APIDOC
## gp_port_close()

### Description
Closes the port connection.

### Method
(Not specified, likely a C function call)

### Endpoint
N/A

### Parameters
(Not specified)

### Request Example
N/A

### Response
(Not specified)
```

```APIDOC
## gp_port_flush()

### Description
Flushes any buffered data on the port.

### Method
(Not specified, likely a C function call)

### Endpoint
N/A

### Parameters
(Not specified)

### Request Example
N/A

### Response
(Not specified)
```

```APIDOC
## gp_port_free()

### Description
Frees the resources associated with the port object.

### Method
(Not specified, likely a C function call)

### Endpoint
N/A

### Parameters
(Not specified)

### Request Example
N/A

### Response
(Not specified)
```

```APIDOC
## gp_port_get_error()

### Description
Retrieves the last error code from the port.

### Method
(Not specified, likely a C function call)

### Endpoint
N/A

### Parameters
(Not specified)

### Request Example
N/A

### Response
(Not specified)
```

```APIDOC
## gp_port_get_info()

### Description
Retrieves information about the port.

### Method
(Not specified, likely a C function call)

### Endpoint
N/A

### Parameters
(Not specified)

### Request Example
N/A

### Response
(Not specified)
```

```APIDOC
## gp_port_get_pin()

### Description
Retrieves the status of a specific port pin.

### Method
(Not specified, likely a C function call)

### Endpoint
N/A

### Parameters
(Not specified)

### Request Example
N/A

### Response
(Not specified)
```

```APIDOC
## gp_port_get_settings()

### Description
Retrieves the current settings of the port.

### Method
(Not specified, likely a C function call)

### Endpoint
N/A

### Parameters
(Not specified)

### Request Example
N/A

### Response
(Not specified)
```

```APIDOC
## gp_port_get_timeout()

### Description
Retrieves the timeout value for port operations.

### Method
(Not specified, likely a C function call)

### Endpoint
N/A

### Parameters
(Not specified)

### Request Example
N/A

### Response
(Not specified)
```

--------------------------------

### gp_widget_get_name

Source: http://www.gphoto.org/doc/api/gphoto2-widget_8h.html

Gets the name of the widget.

```APIDOC
## gp_widget_get_name

### Description
Gets the name of the widget.

### Parameters
- **widget** (CameraWidget *) - The CameraWidget to get the name from.
- **name** (const char **) - A pointer to store the name string.

### Returns
A gphoto2 error code. References GP_OK.
Referenced by gp_camera_get_single_config().
```

--------------------------------

### gp_widget_get_name

Source: http://www.gphoto.org/doc/api/gphoto2-widget_8c.html

Gets the name of the widget.

```APIDOC
## gp_widget_get_name

### Description
Gets the name of the widget.

### Parameters
- **widget** (CameraWidget) - A CameraWidget.
- **name** (const char **) - Pointer to store the widget's name.

### Returns
A gphoto2 error code. References GP_OK.
```

--------------------------------

### gp_widget_get_name

Source: http://www.gphoto.org/doc/api/gphoto2-widget_8h_source.html

Gets the name of a CameraWidget.

```APIDOC
## gp_widget_get_name

### Description
Gets the name of the widget.

### Signature
```c
int gp_widget_get_name(CameraWidget *widget, const char **name)
```

### Parameters
- **widget** (CameraWidget *) - The widget to get the name from.
- **name** (const char **) - Pointer to store the name string.
```

--------------------------------

### camera_init

Source: http://www.gphoto.org/doc/api/gphoto2-library_8h.html

Initializes the camera, establishing a connection and configuring settings.

```APIDOC
## camera_init

### Description
Initializes the camera.

### Parameters
- **camera** (Camera *) - A pointer to the Camera structure.
- **context** (GPContext *) - A pointer to the GPContext structure.

### Returns
A gphoto2 error code.
```

--------------------------------

### gp_file_get_name

Source: http://www.gphoto.org/doc/api/gphoto2-file_8c.html

Gets the name of a CameraFile.

```APIDOC
## gp_file_get_name

### Description
Gets the name of a CameraFile.

### Parameters
- **file** (CameraFile *) - A CameraFile object.
- **name** (const char **) - A pointer to store the name string.

### Returns
A gphoto2 error code. References GP_OK.
```

--------------------------------

### gp_camera_init Function

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8c.html

Initializes the camera connection and prepares it for use. Requires a valid Camera object and GPContext.

```c
int gp_camera_init(Camera *camera, GPContext *context)
**Definition:** gphoto2-camera.c:683

```

--------------------------------

### Remove old gphoto2 installations

Source: http://www.gphoto.org/doc/faq

Clean up old gphoto2 and libgphoto2 files from common library paths. This is crucial when you have multiple versions installed, especially from different sources like package managers and source builds.

```bash
rm -rf /usr/local/lib/gphoto2* /usr/local/lib/libgphoto2*
rm -rf /usr/lib/gphoto2* /usr/lib/libgphoto2*
```

--------------------------------

### gp_camera_init

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8c.html

Initiate a connection to the camera.

```APIDOC
## gp_camera_init

### Description
Initiate a connection to the `camera`.

### Parameters
#### Path Parameters
- **camera** (Camera *) - Description: a Camera
- **context** (GPContext *) - Description: a GPContext

### Returns
a gphoto2 error code
```

--------------------------------

### gp_port_get_settings

Source: http://www.gphoto.org/doc/api/gphoto2-port_8c.html

Gets the current settings of the port.

```APIDOC
## gp_port_get_settings

### Description
Retrieves the current settings of a port.

### Parameters
- **port** (GPPort *) - A GPPort structure.
- **settings** (GPPortSettings *) - A pointer to a GPPortSettings structure to store the retrieved settings.

### Returns
- A gphoto2 error code.
```

--------------------------------

### List Configuration Values

Source: http://www.gphoto.org/doc/manual/ref-gphoto2-cli.html

Lists all available configuration settings for the connected camera.

```bash
list-config
```

--------------------------------

### Create Directory

Source: http://www.gphoto.org/doc/manual/ref-gphoto2-cli.html

Creates a new directory with the specified name on the camera.

```bash
mkdir _`DIRECTORY`_
```

--------------------------------

### gp_file_get_mtime

Source: http://www.gphoto.org/doc/api/gphoto2-file_8c.html

Gets the modification time of a CameraFile.

```APIDOC
## gp_file_get_mtime

### Description
Gets the modification time of a CameraFile.

### Parameters
- **file** (CameraFile *) - A CameraFile object.
- **mtime** (time_t *) - A pointer to store the modification time.

### Returns
A gphoto2 error code. References GP_OK.
```

--------------------------------

### gp_file_get_mime_type

Source: http://www.gphoto.org/doc/api/gphoto2-file_8c.html

Gets the MIME type of a CameraFile.

```APIDOC
## gp_file_get_mime_type

### Description
Gets the MIME type of a CameraFile.

### Parameters
- **file** (CameraFile *) - A CameraFile object.
- **mime_type** (const char **) - A pointer to store the MIME type string.

### Returns
A gphoto2 error code. References GP_OK.
```

--------------------------------

### Configure v4l2loopback for Webcam

Source: http://www.gphoto.org/doc/remote

Load the v4l2loopback kernel module to create a virtual video device. Use `ls -la /dev/video*` to find the device path.

```bash
sudo modprobe v4l2loopback exclusive_caps=1 card_label="GPhoto2 Webcam"
```

--------------------------------

### gp_port_info_list_get_info

Source: http://www.gphoto.org/doc/api/gphoto2-port-info-list_8c.html

Gets port information of a specific entry.

```APIDOC
## int gp_port_info_list_get_info(GPPortInfoList *list, int n, GPPortInfo *info)

### Description
Returns a pointer to the current port entry.

### Parameters
- **list** (GPPortInfoList *) - Required - A GPPortInfoList structure.
- **n** (int) - Required - The index of the entry.
- **info** (GPPortInfo *) - Required - The returned information.

### Returns
- **int** - A gphoto2 error code.
```

--------------------------------

### List Camera Configuration Options

Source: http://www.gphoto.org/doc/remote

Use `--list-config` to see all available configuration options for your camera. Some options may only appear after setting `capture=on`.

```bash
gphoto2 --list-config
```

--------------------------------

### gp_port_get_timeout

Source: http://www.gphoto.org/doc/api/gphoto2-port_8c.html

Gets the current timeout value for the port.

```APIDOC
## gp_port_get_timeout

### Description
Retrieves the current timeout value of the port.

### Parameters
- **port** (GPPort *) - A GPPort structure.
- **timeout** (int *) - A pointer to an integer to store the timeout value.

### Returns
- A gphoto2 error code.
```

--------------------------------

### camera_init

Source: http://www.gphoto.org/doc/api/gphoto2-library_8h_source.html

Initializes the camera, preparing it for interaction.

```APIDOC
## camera_init

### Description
Initializes the camera.

### Signature
```c
int camera_init(Camera *camera, GPContext *context)
```

### Definition
gphoto2-library.h:65
```

--------------------------------

### gp_port_get_pin

Source: http://www.gphoto.org/doc/api/gphoto2-port_8c.html

Gets the setting of a specific serial PIN.

```APIDOC
## gp_port_get_pin

### Description
Gets the setting of a specific serial PIN on the port.

### Parameters
- **port** (GPPort *) - A GPPort structure.
- **pin** (GPPin) - The serial pin to be retrieved.
- **level** (GPLevel *) - A pointer to store the setting of the pin (e.g., high or low).

### Returns
- A gphoto2 error code.
```

--------------------------------

### camera_init

Source: http://www.gphoto.org/doc/api/template_8c.html

Initializes a Camera object, setting up necessary function pointers and internal data structures, and establishing a connection to the camera.

```APIDOC
## camera_init

### Description
Initialize a Camera object. Sets up all the proper object function pointers, initialize camlib internal data structures, and probably establish a connection to the camera.

### Function Signature
int camera_init(Camera * _camera_, GPContext * _context_)

### Notes
This is a camlib API function.
```

--------------------------------

### camera_init

Source: http://www.gphoto.org/doc/api/gphoto2-library_8h.html

Initializes a `Camera` object, setting up function pointers and internal data structures, and potentially establishing a connection to the camera.

```APIDOC
## camera_init

### Description
Initialize a Camera object.

### Parameters
- **camera** (Camera *) - A pointer to the `Camera` object to be initialized.
- **context** (GPContext *) - The `GPContext` for the operation.

### Returns
- A gphoto2 error code indicating success or failure.

### Details
This function sets up the necessary object function pointers, initializes camlib internal data structures, and may establish a connection to the camera. It is a core function for preparing a camera for interaction.
```

--------------------------------

### gp_port_get_settings

Source: http://www.gphoto.org/doc/api/gphoto2-port_8c.html

Gets the current configuration settings of a GPPort.

```APIDOC
## gp_port_get_settings

### Description
Gets the current port settings.

### Signature
int gp_port_get_settings (GPPort *port, GPPortSettings *settings)

### Parameters
- **port** (GPPort *) - Pointer to the GPPort structure.
- **settings** (GPPortSettings *) - Pointer to store the retrieved port settings.
```

--------------------------------

### gp_port_get_timeout

Source: http://www.gphoto.org/doc/api/gphoto2-port_8c.html

Gets the current timeout value for the GPPort.

```APIDOC
## gp_port_get_timeout

### Description
Gets the current port timeout value.

### Signature
int gp_port_get_timeout (GPPort *port, int *timeout)

### Parameters
- **port** (GPPort *) - Pointer to the GPPort structure.
- **timeout** (int *) - Pointer to store the retrieved timeout value.
```

--------------------------------

### Initialize build system with autoreconf

Source: http://www.gphoto.org/doc/manual/compilation-from-svn.html

Commands to initialize the automake-based build system for various modules. This step is required before configuring and building the software. Ensure build tools like automake, autoreconf, libtoolize, autopoint, and pkg-config are installed.

```bash
(cd gphoto-suite && autoreconf --install --symlink
```

```bash
(cd libusb && autoreconf --install --symlink)
```

```bash
(cd libexif && autoreconf --install --symlink)
```

```bash
(cd exif && autoreconf --install --symlink)
```

```bash
(cd libexif-gtk && autoreconf --install --symlink)
```

```bash
(cd libgphoto2 && autoreconf --install --symlink)
```

```bash
(cd gphoto2 && autoreconf --install --symlink)
```

```bash
(cd gphotofs && autoreconf --install --symlink)
```

```bash
(cd gtkam && autoreconf --install --symlink)
```

--------------------------------

### Start devfs Service to Apply Changes

Source: http://www.gphoto.org/doc/manual/permissions-usb.html

Run this command to activate the changes made in /etc/devfs.conf. No reboot is required.

```shell
/etc/rc.d/devfs start
```

--------------------------------

### get_file_func

Source: http://www.gphoto.org/doc/api/template_8c.html

Gets the file from the camera. This function is a CameraFilesystem method.

```APIDOC
## get_file_func

### Description
Get the file from the camera.
This function is a CameraFilesystem method.

### Signature
int get_file_func(CameraFilesystem * _fs, const char * _folder, const char * _filename, CameraFileType _type, CameraFile * _file, void * _data, GPContext * _context)
```

--------------------------------

### gp_filesystem_new

Source: http://www.gphoto.org/doc/api/gphoto2-filesys_8c.html

Initializes and creates a new, empty CameraFilesystem structure.

```APIDOC
## gp_filesystem_new

### Description
Allocates and initializes a new CameraFilesystem structure in memory.

### Parameters
- **fs** (CameraFilesystem **) - A pointer to a pointer where the newly created CameraFilesystem structure will be assigned.

### Returns
A gphoto2 error code indicating the success or failure of the operation.
```

--------------------------------

### gp_port_get_pin

Source: http://www.gphoto.org/doc/api/gphoto2-port_8c.html

Gets the status of a specific serial PIN on the GPPort.

```APIDOC
## gp_port_get_pin

### Description
Gets the setting of a specific serial PIN.

### Signature
int gp_port_get_pin (GPPort *port, GPPin pin, GPLevel *level)

### Parameters
- **port** (GPPort *) - Pointer to the GPPort structure.
- **pin** (GPPin) - The specific serial PIN to query.
- **level** (GPLevel *) - Pointer to store the level of the PIN.
```

--------------------------------

### gp_port_get_pin

Source: http://www.gphoto.org/doc/api/gphoto2-port_8h.html

Gets the status of a specific serial PIN on the port.

```APIDOC
## gp_port_get_pin

### Description
Gets the setting of a specific serial PIN.

### Signature
int gp_port_get_pin(GPPort *port, GPPin pin, GPLevel *level)

### Parameters
- **port** (GPPort *) - Pointer to the GPPort structure.
- **pin** (GPPin) - The serial PIN to query.
- **level** (GPLevel *) - Output parameter to store the PIN level.
```

--------------------------------

### gp_filesystem_new

Source: http://www.gphoto.org/doc/api/gphoto2-filesys_8h.html

Initializes and creates a new, empty CameraFilesystem structure.

```APIDOC
## gp_filesystem_new

### Description
Creates a new, empty `CameraFilesystem` structure in memory.

### Parameters
- **fs** (CameraFilesystem **) - A pointer to a pointer where the newly created CameraFilesystem will be assigned.

### Returns
A gphoto2 error code. References GP_ERROR_NO_MEMORY and GP_OK.
```

--------------------------------

### Setting Management

Source: http://www.gphoto.org/doc/api/globals_func_g.html

Functions for getting and setting configuration settings.

```APIDOC
## gp_setting_get

### Description
Gets the value of a specific setting.

### Function Signature
`gp_setting_get(GPhoto2Settings *settings, const char *key, void *value)`

## gp_setting_set

### Description
Sets the value of a specific setting.

### Function Signature
`gp_setting_set(GPhoto2Settings *settings, const char *key, const void *value)`
```

--------------------------------

### libgphoto2 HAL Device Information File

Source: http://www.gphoto.org/doc/manual/permissions-usb.html

Example content of the libgphoto2 HAL FDI device list file, defining camera capabilities based on USB vendor and product IDs.

```xml
<?xml version="1.0" encoding="ISO-8859-1"?> <!-- -*- SGML -*- -->
<!-- This file was generated by libgphoto2 print-camera-list - - fdi -->
<deviceinfo version="0.2">
 <device>
  <match key="info.bus" string="usb">
   <match key="usb.vendor_id" int="1363">
    <match key="usb.product_id" int="514">
     <merge key="info.category" type="string">camera</merge>
     <append key="info.capabilities" type="strlist">camera</append>
     <merge key="camera.access_method" type="string">proprietary</merge>
     <merge key="camera.libgphoto2.name" type="string">AEG Snap 300</merge>
     <merge key="camera.libgphoto2.support" type="bool">true</merge>
    </match>
   </match>
     ...
   <match key="usb.vendor_id" int="10096">
    <match key="usb.product_id" int="36956">
     <merge key="info.category" type="string">camera</merge>
     <append key="info.capabilities" type="strlist">camera</append>
     <merge key="camera.access_method" type="string">proprietary</merge>
     <merge key="camera.libgphoto2.name" type="string">Vivitar Vivicam35</merge>
     <merge key="camera.libgphoto2.support" type="bool">true</merge>
    </match>
   </match>
  </match>
 </device>
</deviceinfo>

```

--------------------------------

### gp_file_get_name

Source: http://www.gphoto.org/doc/api/globals_func_g.html

Gets the name of a file. Source: gphoto2-file.c, gphoto2-file.h

```APIDOC
## gp_file_get_name()

### Description
Retrieves the name of the file.

### Source
gphoto2-file.c, gphoto2-file.h
```

--------------------------------

### gp_camera_init

Source: http://www.gphoto.org/doc/api/globals_func_g.html

Initializes the camera interface. Source: gphoto2-camera.c, gphoto2-camera.h

```APIDOC
## gp_camera_init()

### Description
Initializes the connection and communication interface with the camera.

### Source
gphoto2-camera.c, gphoto2-camera.h
```

--------------------------------

### gp_filesystem_number

Source: http://www.gphoto.org/doc/api/gphoto2-filesys_8h_source.html

Gets the index of a file within a specified folder.

```APIDOC
## gp_filesystem_number

### Description
Get the index of a file in specified folder.

### Signature
int gp_filesystem_number(CameraFilesystem *fs, const char *folder, const char *filename, GPContext *context)
```

--------------------------------

### gp_camera_init

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8h_source.html

Initializes the camera connection.

```APIDOC
## gp_camera_init

### Description
Initializes the camera connection.

### Signature
```c
int gp_camera_init(Camera *camera, GPContext *context)
```
```

--------------------------------

### CameraFilesystemGetInfoFunc

Source: http://www.gphoto.org/doc/api/gphoto2-filesys_8h.html

Function pointer type for getting file information.

```APIDOC
## CameraFilesystemGetInfoFunc

### Description
Function pointer type for getting file information.

### Signature
`int (*CameraFilesystemGetInfoFunc) (CameraFilesystem *fs, const char *folder, const char *filename, CameraFileInfo *info, void *data, GPContext *context)`

### Parameters
- **fs** (CameraFilesystem *) - Pointer to the filesystem structure.
- **folder** (const char *) - The folder containing the file.
- **filename** (const char *) - The name of the file.
- **info** (CameraFileInfo *) - Pointer to a CameraFileInfo structure to populate with information.
- **data** (void *) - User-defined data.
- **context** (GPContext *) - The gphoto2 context.
```

--------------------------------

### --list-all-config

Source: http://www.gphoto.org/doc/manual/ref-gphoto2-cli.html

List all configuration entries and their values and choices.

```APIDOC
## --list-all-config

### Description
List all configuration entries and their values and choices.
This command is a combination of `--list-config` and calling `--get-config` on all the entries.
```

--------------------------------

### gp_file_get_data_and_size

Source: http://www.gphoto.org/doc/api/gphoto2-file_8c.html

Gets a pointer to the data and the file's size.

```APIDOC
## gp_file_get_data_and_size

### Description
Gets a pointer to the data and the file's size. Both data and size can be NULL and will then be ignored. The pointer to data that is returned is still owned by libgphoto2 and its lifetime is the same as the #file.

### Parameters
- **file** (CameraFile *) - A CameraFile object.
- **data** (const char **) - A pointer to store the data pointer.
- **size** (unsigned long int *) - A pointer to store the file size.

### Returns
A gphoto2 error code. References GP_ERROR, GP_ERROR_IO, GP_ERROR_IO_READ, GP_FILE_ACCESSTYPE_FD, GP_FILE_ACCESSTYPE_HANDLER, GP_FILE_ACCESSTYPE_MEMORY, and GP_OK.
```

--------------------------------

### CHECK_INIT Macro

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8c.html

Initializes the camera if it's not already in use. Returns GP_ERROR_CAMERA_BUSY if the camera is already in use.

```c
#define CHECK_INIT | ( |  | c,   
---|---|---|---
|  |  | ctx   
| ) | |   
**Value:**
{ 
if ((c)->pc->used)
return (GP_ERROR_CAMERA_BUSY); 
(c)->pc->used++; 
if (!(c)->pc->lh)
CR((c), gp_camera_init (c, ctx), ctx); 
}

```

--------------------------------

### Camera Abilities

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8c.html

Functions to get and set the capabilities of the camera.

```APIDOC
## gp_camera_set_abilities

### Description
Sets the camera abilities.

### Signature
int gp_camera_set_abilities (Camera *camera, CameraAbilities abilities)

## gp_camera_get_abilities

### Description
Gets the camera abilities.

### Signature
int gp_camera_get_abilities (Camera *camera, CameraAbilities *abilities)
```

--------------------------------

### Load USB Drivers and Mount USB Filesystem

Source: http://www.gphoto.org/doc/manual/permissions-usb.html

Load the appropriate USB drivers (e.g., usb-uhci, usb-ohci) and mount the USB device filesystem to `/proc/bus/usb`. This step is crucial for the system to recognize USB devices.

```bash
modprobe usb-uhci
modprobe usb-ohci
mount -t usbfs usb /proc/bus/usb
```

--------------------------------

### gp_camera_get_storageinfo

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8h_source.html

Gets information on the camera's attached storage.

```APIDOC
## gp_camera_get_storageinfo

### Description
Gets information on the camera's attached storage.

### Signature
```c
int gp_camera_get_storageinfo(Camera *camera, CameraStorageInformation **, int *, GPContext *context)
```
```

--------------------------------

### Camera Configuration

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8h_source.html

Functions for getting and setting camera configurations.

```APIDOC
## gp_camera_get_config

### Description
Retrieves the current camera configuration.

### Parameters
- **camera** (Camera *) - Pointer to the Camera structure.
- **window** (CameraWidget **) - Pointer to a CameraWidget structure to store the configuration.
- **context** (GPContext *) - Pointer to the GPContext structure.

### Returns
An integer status code.
```

```APIDOC
## gp_camera_list_config

### Description
Lists the available configuration options for the camera.

### Parameters
- **camera** (Camera *) - Pointer to the Camera structure.
- **list** (CameraList *) - Pointer to a CameraList structure to store the configuration list.
- **context** (GPContext *) - Pointer to the GPContext structure.

### Returns
An integer status code.
```

```APIDOC
## gp_camera_get_single_config

### Description
Retrieves a specific configuration setting by name.

### Parameters
- **camera** (Camera *) - Pointer to the Camera structure.
- **name** (const char *) - The name of the configuration setting.
- **widget** (CameraWidget **) - Pointer to a CameraWidget structure to store the setting.
- **context** (GPContext *) - Pointer to the GPContext structure.

### Returns
An integer status code.
```

```APIDOC
## gp_camera_set_config

### Description
Sets the camera configuration.

### Parameters
- **camera** (Camera *) - Pointer to the Camera structure.
- **window** (CameraWidget *) - Pointer to the CameraWidget structure containing the new configuration.
- **context** (GPContext *) - Pointer to the GPContext structure.

### Returns
An integer status code.
```

```APIDOC
## gp_camera_set_single_config

### Description
Sets a specific configuration setting by name.

### Parameters
- **camera** (Camera *) - Pointer to the Camera structure.
- **name** (const char *) - The name of the configuration setting.
- **widget** (CameraWidget *) - Pointer to the CameraWidget structure containing the new value.
- **context** (GPContext *) - Pointer to the GPContext structure.

### Returns
An integer status code.
```

--------------------------------

### gp_filesystem_new

Source: http://www.gphoto.org/doc/api/gphoto2-filesys_8h_source.html

Creates and initializes a new CameraFilesystem structure.

```APIDOC
## gp_filesystem_new

### Description
Create a new filesystem struct.

### Signature
```c
int gp_filesystem_new(CameraFilesystem **fs)
```

### Parameters
*   **fs** (CameraFilesystem **) - Pointer to a pointer that will store the newly created CameraFilesystem structure.

### Returns
An integer representing the status of the operation. 0 on success, negative on error.
```

--------------------------------

### List /dev/ugen* Permissions (FreeBSD 7 and under)

Source: http://www.gphoto.org/doc/manual/permissions-usb.html

This command shows the permissions for USB devices on older FreeBSD versions, demonstrating user access to ugen devices.

```shell
ls -l /dev/ugen*
```

--------------------------------

### File Creation and Initialization

Source: http://www.gphoto.org/doc/api/gphoto2-file_8c.html

Functions for creating and initializing CameraFile objects.

```APIDOC
## gp_file_new

### Description
Creates a new, empty CameraFile object.

### Function Signature
```c
int gp_file_new (CameraFile **file)
```

## gp_file_new_from_fd

### Description
Creates a new CameraFile object from an existing file descriptor.

### Function Signature
```c
int gp_file_new_from_fd (CameraFile **file, int fd)
```

## gp_file_new_from_handler

### Description
Creates a new CameraFile object using a custom file handler.

### Function Signature
```c
int gp_file_new_from_handler (CameraFile **file, CameraFileHandler *handler, void *private)
```
```

--------------------------------

### gp_camera_start_timeout

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8h_source.html

Starts a timeout for a camera operation with a callback function.

```APIDOC
## gp_camera_start_timeout

### Description
Starts a timeout for a camera operation with a callback function.

### Signature
```c
int gp_camera_start_timeout(Camera *camera, unsigned int timeout, CameraTimeoutFunc func)
```
```

--------------------------------

### gp_filesystem_number

Source: http://www.gphoto.org/doc/api/gphoto2-filesys_8h.html

Gets the index number of a file within a specified folder.

```APIDOC
## gp_filesystem_number

### Description
Looks for a file named `filename` in the given `folder` and returns its index number. This is the inverse operation of `gp_filesystem_name()`.

### Parameters
- **fs** (CameraFilesystem *) - A pointer to the CameraFilesystem structure.
- **folder** (const char *) - The folder where the file is to be searched.
- **filename** (const char *) - The name of the file to search for.
- **context** (GPContext *) - A pointer to the GPContext for operation.

### Returns
A gphoto2 error code. References GP_ERROR_DIRECTORY_NOT_FOUND, GP_ERROR_FILE_NOT_FOUND, and GP_OK.
```

--------------------------------

### gp_file_get_mtime

Source: http://www.gphoto.org/doc/api/globals_func_g.html

Gets the modification time of a file. Source: gphoto2-file.c, gphoto2-file.h

```APIDOC
## gp_file_get_mtime()

### Description
Retrieves the last modification time of the file.

### Source
gphoto2-file.c, gphoto2-file.h
```

--------------------------------

### gp_file_get_mime_type

Source: http://www.gphoto.org/doc/api/globals_func_g.html

Gets the MIME type of a file. Source: gphoto2-file.c, gphoto2-file.h

```APIDOC
## gp_file_get_mime_type()

### Description
Retrieves the MIME type associated with the file.

### Source
gphoto2-file.c, gphoto2-file.h
```

--------------------------------

### Checkout gphoto-suite from SVN

Source: http://www.gphoto.org/doc/manual/compilation-from-svn.html

Use this command to check out the main gphoto-suite source code from its SVN repository. This is the primary method for obtaining the entire suite.

```bash
svn _checkout_ _https://gphoto.svn.sourceforge.net/svnroot/gphoto/trunk/gphoto-suite_
```

--------------------------------

### gp_filesystem_number

Source: http://www.gphoto.org/doc/api/gphoto2-filesys_8c.html

Gets the index number of a specific file within a folder.

```APIDOC
## gp_filesystem_number

### Description
Gets the index of a file in specified folder.

### Signature
int gp_filesystem_number(CameraFilesystem *fs, const char *folder, const char *filename, GPContext *context)
```

--------------------------------

### Configure USB Camera Hotplug Map (Old Method)

Source: http://www.gphoto.org/doc/manual/permissions-usb.html

For older distributions or if the new method is insufficient, modify `/etc/hotplug/usb.usermap`. Remove existing `usbcam` entries and append the output of `print-usb-usermap`.

```bash
/usr/lib/libgphoto2/print-usb-usermap >> /etc/hotplug/usb.usermap
```

--------------------------------

### Troubleshoot Camera Not Found by gphoto2

Source: http://www.gphoto.org/doc/manual/FAQ.html

Verify camera support and check if the necessary ports are listed using `--list-ports`. Ensure libusb is compiled and usbfs is mounted if using USB devices. Avoid running gphoto2 as root.

```bash
gphoto2 --list-ports
```

```bash
gphoto2 --auto-detect
```

--------------------------------

### File Name Operations

Source: http://www.gphoto.org/doc/api/gphoto2-file_8h_source.html

Functions for setting and getting the name of a CameraFile.

```APIDOC
## File Name Operations

### Description
Functions for setting and getting the name of a CameraFile.

### Functions

- **gp_file_set_name**: Sets the name of the CameraFile.
- **gp_file_get_name**: Retrieves the name of the CameraFile.
```

--------------------------------

### Camera Configuration

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8c.html

Functions for getting, setting, and listing camera configurations.

```APIDOC
## gp_camera_get_config

### Description
Retrieves the current camera configuration.

### Signature
int gp_camera_get_config (Camera *camera, CameraWidget **window, GPContext *context)

## gp_camera_get_single_config

### Description
Retrieves a specific configuration setting by name.

### Signature
int gp_camera_get_single_config (Camera *camera, const char *name, CameraWidget **widget, GPContext *context)

## gp_camera_list_config

### Description
Lists the available configuration settings for the camera.

### Signature
int gp_camera_list_config (Camera *camera, CameraList *list, GPContext *context)

## gp_camera_set_config

### Description
Applies a new camera configuration.

### Signature
int gp_camera_set_config (Camera *camera, CameraWidget *window, GPContext *context)

## gp_camera_set_single_config

### Description
Sets a specific configuration setting by name.

### Signature
int gp_camera_set_single_config (Camera *camera, const char *name, CameraWidget *widget, GPContext *context)
```

--------------------------------

### List files for a specific camera model

Source: http://www.gphoto.org/doc/manual/port-and-camera.html

Use this command to list files on a camera, specifying the camera model. The chosen camera model is stored in ~/.gphoto/settings for future use.

```bash
gphoto2 --camera "Canon PowerShot G2" --list-files
```

--------------------------------

### Capture Preview

Source: http://www.gphoto.org/doc/manual/ref-gphoto2-cli.html

Captures a preview image and downloads it from the camera.

```bash
capture-preview
```

--------------------------------

### gp_camera_file_get_info

Source: http://www.gphoto.org/doc/api/globals_func_g.html

Gets information about a file on the camera. Source: gphoto2-camera.c, gphoto2-camera.h

```APIDOC
## gp_camera_file_get_info()

### Description
Retrieves metadata and information about a file stored on the camera.

### Source
gphoto2-camera.c, gphoto2-camera.h
```

--------------------------------

### camera_init

Source: http://www.gphoto.org/doc/api/gphoto2-library_8c.html

Initializes the connection with the camera. This function sets up the necessary communication channels and configures the camera's filesystem operations.

```APIDOC
## camera_init

### Description
Initialize the camera.

### Parameters
- **camera** (Camera *) - Description: a Camera

### Returns
- a gphoto2 error code
```

--------------------------------

### gp_camera_file_read

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8h_source.html

Reads data from a file on the camera, starting at a specified offset.

```APIDOC
## gp_camera_file_read

### Description
Reads data from a file on the camera, starting at a specified offset.

### Signature
```c
int gp_camera_file_read(Camera *camera, const char *folder, const char *file, CameraFileType type, uint64_t offset, char *buf, uint64_t *size, GPContext *context)
```
```

--------------------------------

### Progress Tracking

Source: http://www.gphoto.org/doc/api/gphoto2-context_8c.html

Functions for starting, updating, and stopping progress tracking.

```APIDOC
## gp_context_progress_start

### Description
Start progress tracking.

### Signature
unsigned int gp_context_progress_start (GPContext *context, float target, const char *format,...)

## gp_context_progress_update

### Description
Update the current progress value.

### Signature
void gp_context_progress_update (GPContext *context, unsigned int id, float current)

## gp_context_progress_stop

### Description
Stop progress tracking.

### Signature
void gp_context_progress_stop (GPContext *context, unsigned int id)
```

--------------------------------

### Camera Initialization and Exit

Source: http://www.gphoto.org/doc/api/gphoto2-camera_8c.html

Functions for initializing a camera connection and cleaning up resources.

```APIDOC
## gp_camera_new

### Description
Creates a new camera instance.

### Signature
int gp_camera_new (Camera **camera)

## gp_camera_exit

### Description
Exits the camera interface and frees resources.

### Signature
int gp_camera_exit (Camera *camera, GPContext *context)
```

--------------------------------

### gp_list_new

Source: http://www.gphoto.org/doc/api/gphoto2-list_8c.html

Creates and initializes a new, empty CameraList.

```APIDOC
## gp_list_new

### Description
Creates a new CameraList.

### Parameters
- **list** (CameraList **) - Pointer to a CameraList pointer where the new list will be stored.

### Returns
A gphoto2 error code. References GP_OK.
```

--------------------------------

### --list-config

Source: http://www.gphoto.org/doc/manual/ref-gphoto2-cli.html

List all configuration entries.

```APIDOC
## --list-config

### Description
List all configuration entries.
```

--------------------------------

### storage_info_func

Source: http://www.gphoto.org/doc/api/template_8c.html

Gets information on all available storages in the camera. This function is a CameraFilesystem method.

```APIDOC
## storage_info_func

### Description
Get information on all available storages in the camera.
This function is a CameraFilesystem method.

### Signature
int storage_info_func(CameraFilesystem * _fs, CameraStorageInformation ** _storageinformations, int * _nrofstorageinformations, void * _data, GPContext * _context)
```

--------------------------------

### JPEG Marker Information

Source: http://www.gphoto.org/doc/api/jpeg_8c.html

Utility functions to get the name of a JPEG marker.

```APIDOC
## gpi_jpeg_markername

### Description
Returns the string name of a given JPEG marker code.

### Function Signature
char * gpi_jpeg_markername(unsigned int c)
```

--------------------------------

### gp_filesystem_new

Source: http://www.gphoto.org/doc/api/gphoto2-filesys_8c.html

Creates a new CameraFilesystem structure.

```APIDOC
## gp_filesystem_new

### Description
Creates a new filesystem struct.

### Signature
int gp_filesystem_new(CameraFilesystem **fs)
```

--------------------------------

### Port Settings Functions

Source: http://www.gphoto.org/doc/api/gphoto2-port_8h_source.html

Functions to get and set the specific settings for a port.

```APIDOC
## gp_port_set_settings

### Description
Sets the configuration settings for the port.

### Function Signature
`int gp_port_set_settings (GPPort *port, GPPortSettings settings);`

### Parameters
- **port** (GPPort *) - Pointer to the GPPort.
- **settings** (GPPortSettings) - The port settings to apply.
```

```APIDOC
## gp_port_get_settings

### Description
Retrieves the current configuration settings of the port.

### Function Signature
`int gp_port_get_settings (GPPort *port, GPPortSettings *settings);`

### Parameters
- **port** (GPPort *) - Pointer to the GPPort.
- **settings** (GPPortSettings *) - Pointer to a GPPortSettings structure to store the retrieved settings.
```

--------------------------------

### camera_init

Source: http://www.gphoto.org/doc/api/globals_func.html

Initializes the connection to the camera. This must be called before most other camera operations.

```APIDOC
## camera_init()

### Description
Initializes the connection to the camera. This must be called before most other camera operations.

### Method
N/A (C function)

### Endpoint
N/A (C function)

### Parameters
None explicitly documented in this context.

### Request Example
N/A

### Response
N/A (Function return type not specified in source)

```
Tokens:
Raw