Repository Summary
Checkout URI | https://github.com/ctu-vras/snmp_ros.git |
VCS Type | git |
VCS Version | master |
Last Updated | 2023-04-16 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
snmp_ros | 1.0.3 |
README
SNMP ROS
Utilities for working with SNMP from ROS.
This package only supports a very small subset of SNMP. Basically, just reading single OIDs from SNMPv1/v2 agents. Notably, the node currently cannot interpret MIBs. Pull requests for additional functionality are welcome.
Node snmp_reader
ROS node that allows reading OID values via SNMP into ROS topics or parameters.
Parameters
-
~agent_address
(typestring
, default “127.0.0.1”): IP address of the SNMP agent. -
~agent_port
(typeint
, default 161): Port to connect to. -
~community
(typestring
, default “public”): The community to connect to. -
~snmp_v2
(typebool
, defaultTrue
): If True, v2 is used, otherwise SNMP v1 is used. -
~topics
(typedict
, default{}
): List of OIDs that should be periodically read and published as topics.- Each item in
topics
is a dict with the following items: -
oid
(typestring
): The OID to read. -
type
(typestring
, defaultString
): Type of the ROS message to parse the value as. Use ROS message type names likeInt32
. -
topic
(typestring
, defaults to the key of this dictionary entry): The topic to publish the value to. Prepend~
to publish it as a private topic. -
rate
(typefloat
, default1.0
): Publishing rate. If set to 0, the value is only read once and published latched.
- Each item in
-
~params
(typedict
, default{}
): List of OIDs that should be read once and set as ROS parameters.- Each item in
params
is a dict with the following items: -
oid
(typestring
): The OID to read. -
type
(typestring
, defaultstr
): Type Python type to parse the value as. Use Python type names likeint
. -
parameter
(typestring
, defaults to the key of this dictionary entry): The parameter to set the value to. Prepend~
to set a private parameter.
- Each item in
Published topics
- configured by the
~topics
parameter.
Usage
Just run the snmp_reader
node and pass it the required configuration. Look into the config
folder for examples of the node configuration.
CONTRIBUTING
Repository Summary
Checkout URI | https://github.com/ctu-vras/snmp_ros.git |
VCS Type | git |
VCS Version | master |
Last Updated | 2023-04-16 |
Dev Status | DEVELOPED |
CI status | No Continuous Integration |
Released | RELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (0)
Good First Issues (0) Pull Requests to Review (0) |
Packages
Name | Version |
---|---|
snmp_ros | 1.0.3 |
README
SNMP ROS
Utilities for working with SNMP from ROS.
This package only supports a very small subset of SNMP. Basically, just reading single OIDs from SNMPv1/v2 agents. Notably, the node currently cannot interpret MIBs. Pull requests for additional functionality are welcome.
Node snmp_reader
ROS node that allows reading OID values via SNMP into ROS topics or parameters.
Parameters
-
~agent_address
(typestring
, default “127.0.0.1”): IP address of the SNMP agent. -
~agent_port
(typeint
, default 161): Port to connect to. -
~community
(typestring
, default “public”): The community to connect to. -
~snmp_v2
(typebool
, defaultTrue
): If True, v2 is used, otherwise SNMP v1 is used. -
~topics
(typedict
, default{}
): List of OIDs that should be periodically read and published as topics.- Each item in
topics
is a dict with the following items: -
oid
(typestring
): The OID to read. -
type
(typestring
, defaultString
): Type of the ROS message to parse the value as. Use ROS message type names likeInt32
. -
topic
(typestring
, defaults to the key of this dictionary entry): The topic to publish the value to. Prepend~
to publish it as a private topic. -
rate
(typefloat
, default1.0
): Publishing rate. If set to 0, the value is only read once and published latched.
- Each item in
-
~params
(typedict
, default{}
): List of OIDs that should be read once and set as ROS parameters.- Each item in
params
is a dict with the following items: -
oid
(typestring
): The OID to read. -
type
(typestring
, defaultstr
): Type Python type to parse the value as. Use Python type names likeint
. -
parameter
(typestring
, defaults to the key of this dictionary entry): The parameter to set the value to. Prepend~
to set a private parameter.
- Each item in
Published topics
- configured by the
~topics
parameter.
Usage
Just run the snmp_reader
node and pass it the required configuration. Look into the config
folder for examples of the node configuration.