Robotics.ROS.Pkg

The Robot Operating System (ROS) is a set of software libraries and tools that help you build robot applications. From drivers to state-of-the-art algorithms, and with powerful developer tools, ROS has what you need for your next robotics project. And it's all open source.

Packages are the main unit for organizing software in ROS. A package may contain ROS runtime processes (nodes), a ROS-dependent library, datasets, configuration files, or anything else that is usefully organized together. Packages are the most atomic build item and release item in ROS. Meaning that the most granular thing you can build and release is a package.

This package provide utility and library for fast search ROS packages, collect information from package.xml files and some additional power, e.g. message files finder.

Package search

Single package request

package :: PkgName -> IO (Maybe Package)

Take a package by name

All-in-one request

packageList :: IO [Package]

Take a full package list

Messages search

Single package request

pkgMessages :: Package -> IO [FilePath]

Take message files of given package

All-in-one request

messageList :: IO [(Package, [FilePath])]

Search message files for all packages.

Like to

    packageList >>= mapM pkgMessages 

Package info types

data PackageMeta

Common used package information

Constructors

PackageMeta

Fields

• pkgName :: PkgName

  Name

• pkgVersion :: Text

  Version

• pkgDescription :: Text

  Description

• pkgLicense :: Text

  License

• pkgBuildDeps :: [PkgName]

  List of build dependencies

• pkgRunDeps :: [PkgName]

  List of run dependencies

Instances

Eq PackageMeta

Methods

(==) :: PackageMeta -> PackageMeta -> Bool

(/=) :: PackageMeta -> PackageMeta -> Bool

Ord PackageMeta

Methods

compare :: PackageMeta -> PackageMeta -> Ordering

(<) :: PackageMeta -> PackageMeta -> Bool

(<=) :: PackageMeta -> PackageMeta -> Bool

(>) :: PackageMeta -> PackageMeta -> Bool

(>=) :: PackageMeta -> PackageMeta -> Bool

max :: PackageMeta -> PackageMeta -> PackageMeta

min :: PackageMeta -> PackageMeta -> PackageMeta

Show PackageMeta

Methods

showsPrec :: Int -> PackageMeta -> ShowS

show :: PackageMeta -> String

showList :: [PackageMeta] -> ShowS

data Package

ROS package information

Constructors

Package

Fields

• path :: FilePath

  Package absolute path

• meta :: PackageMeta

  Package meta information

Instances

Eq Package

Methods

(==) :: Package -> Package -> Bool

(/=) :: Package -> Package -> Bool

Ord Package

Methods

compare :: Package -> Package -> Ordering

(<) :: Package -> Package -> Bool

(<=) :: Package -> Package -> Bool

(>) :: Package -> Package -> Bool

(>=) :: Package -> Package -> Bool

max :: Package -> Package -> Package

min :: Package -> Package -> Package

Show Package

Methods

showsPrec :: Int -> Package -> ShowS

show :: Package -> String

showList :: [Package] -> ShowS

type PkgName = Text

Package name type