ifm3d

Library and utilities for working with ifm pmd-based 3D ToF Cameras.

Current Revision

A full software compatibility matrix, including older releases, is available here.

Organization of the Software

The ifm3d software is organized into modules, they are:

As of version 0.9.0, we have removed the viewer sub-command from the ifm3d command line tool (part of the tools module). The objective was to lessen the dependencies for the core library. However, a clone of the pre-0.9.0 viewer is available in its own repository: ifm3d-pcl-viewer.

Installing the Software

Binaries for ifm3d are available on a few supported platforms. Instructions for each now follow.

Linux

Snap Application

The ifm3d command line utility and viewer tool are available as a snap in the Snapcraft application store. Snapcraft supports most major Linux distributions. The storefront page for ifm3d is: https://snapcraft.io/ifm3d

To install the package on a snapd enabled system:

$ sudo snap install ifm3d

After installation, the commands ifm3d and ifm3d.viewer should be available.

NOTE: This option is a convenient way to install and update tools and utilities for working with ifm Cameras. This option is not suitable for developers hoping to target the ifm3d API and shared libraries. Developers should opt for standard debian packages, or building from source.

Ubuntu Linux via Apt (amd64/arm64)

We provide apt repositories for the following Ubuntu Linux distributions and architectures:

Add the repository to your sources.list:

$ sudo sh -c 'echo "deb https://nexus.ifm.com/repository/ifm-robotics_ubuntu_$(lsb_release -sc)_$(dpkg --print-architecture) $(lsb_release -sc) main" > /etc/apt/sources.list.d/ifm-robotics.list'

Add the public key for the repository:

$ sudo apt-key adv --keyserver hkp://ha.pool.sks-keyservers.net:80 --recv-key 8AB59D3A2BD7B692

Install the software:

$ sudo apt-get update
$ sudo apt-get install ifm3d-camera \
                       ifm3d-framegrabber \
                       ifm3d-swupdater \
                       ifm3d-image \
                       ifm3d-opencv \
                       ifm3d-pcicclient \
                       ifm3d-tools \
                       ifm3d-python3 \
                       ifm3d-pcl-viewer \

Linux for Tegra

Linux for Tegra is an NVIDIA Linux distribution for the Jetson family of GPU SoC systems. NVIDIA distributes a software package called JetPack with various utilities and libraries optimized for the target hardware. There are a few pakages which override the core Ubuntu packages (OpenCV as the primary example). We provide alternate apt repositories for ifm3d built on top of the JetPack libraries rather than the Ubuntu libraries.

Add one of the following repositories based on your desired JetPack/L4T release:

Jetpack 4.4:

$ sudo sh -c 'echo "deb https://nexus.ifm.com/repository/ifm-robotics_l4t_jetpack_4_4_arm64 melodic main" > /etc/apt/sources.list.d/ifm-robotics.list'

Jetpack 4.3:

$ sudo sh -c 'echo "deb https://nexus.ifm.com/repository/ifm-robotics_l4t_jetpack_4_3_arm64 melodic main" > /etc/apt/sources.list.d/ifm-robotics.list'

Add the public key for the repository:

$ sudo apt-key adv --keyserver hkp://ha.pool.sks-keyservers.net:80 --recv-key 8AB59D3A2BD7B692

Install the software:

$ sudo apt-get update
$ sudo apt-get install ifm3d-camera \
                       ifm3d-framegrabber \
                       ifm3d-swupdater \
                       ifm3d-image \
                       ifm3d-opencv \
                       ifm3d-pcicclient \
                       ifm3d-tools \
                       ifm3d-python3 \
                       ifm3d-pcl-viewer \

ROS/ROS2

For users interested in using our ROS bindings, ifm3d and ifm3d-ros are both available in the ROS distribution for Kinetic and Melodic (Noetic coming shortly).

$ sudo apt install ros-kinetic-ifm3d

or

$ sudo apt install ros-melodic-ifm3d

For users interested in using our ROS2 bindings, binaries will be included (starting with dashing) very soon. For now, packages must be built from source. Do not use the debian mirror for ifm3d since (depending on version) ROS2 ships parallel versions of some core libraries (OpenCV, PCL) as compared with standard Ubuntu. ifm3d must be built against the proper dependencies.

Windows

Pre-built binaries are not yet available. For now we recommend manually compiling for the target MSVC/SDK versions according to the building on windows instructions.

Other platforms

If you are running on a platform we did not mention above, the links below will assist you in building from source code. Alternatively, if you are simply looking to do a quick evaluation of an ifm3d supported sensor we recommend either the Snapcraft option discussed above, or Docker containers.

Additional Resources

• Building from source on Linux
• Building on Windows
• Building and using Python bindings
• Basic library usage
• ifm3d command line tool
• Configuring Your Camera
• Viewing the Point Cloud
• Implementing your own image container
• ROS
• ROS 2
• Troubleshoot
• Computing Cartesian data off-board using the ifm3dpy Python bindings.

Known Issues, Bugs, and our TODO list

Please see the Github Issue Tracker.

LICENSE

Please see the file called LICENSE.