![]() |
APIs, concepts, guides, and more
|
A command-line utility that allows XML configuration, ENI generation, and more.
rsiconfig
is a command-line utility that allows you to generate XML configuration files, restore settings from XML configuration files, generate ENI files, check the RMP serial number, and check the RMP license.
The RMP Motion Controller is software-based and does not have flash memory, nor are its configurations stored in a file.
XML configurations give your application the most flexibility for configuring the RMP as needed at runtime. This is better than using hard-coded values in your RapidCode application. Is also useful when upgrading to a new RMP version.
There are two types of XML configuration files:
Using the rsiconfig utility will help guarantee that your RMP is correctly configured and ready to run before your RapidCode application starts. It allows you to keep hard-coded constants out of your source code. It also can help you generate XML configurations for your current settings, get the serial number, check the RMP license and generate ENI files.
After the EtherCAT network is running and all Axis settings configured, use:
--cpu-affinity
and the Primary NIC (for RMP network) --primary-nic
. See MotionController CreationParameters. Where {YOUR_CPU_INDEX} should be replaced with the CPU core index where RMP should run and {YOUR_NIC_NAME} should be replaced with the NIC name for your EtherCAT network.
Which will generate the file, settings.xml
:
This file, settings.xml
, can be used to apply configurations to a freshly-started RMP in the future. It also creates the Axis XML files, such as Axis 0.xml
.
To initialize the RMP, its network and restore from XML files, use
--cpu-affinity
and the Primary NIC (for RMP network) --primary-nic
. See MotionController CreationParameters. Where {YOUR_CPU_INDEX} should be replaced with the CPU core index where RMP should run and {YOUR_NIC_NAME} should be replaced with the NIC name for your EtherCAT network.
which should produce output similar to:
The order of operations:
--no-network
if you are testing software and do not want to start the network.rsiconfig
will return non-zero if there are unexpected nodes or an error restoring configurations.
To generate the ENI file, EtherCAT.xml
, use
--cpu-affinity
and the Primary NIC (for RMP network) --primary-nic
. See MotionController CreationParameters. Where {YOUR_CPU_INDEX} should be replaced with the CPU core index where RMP should run and {YOUR_NIC_NAME} should be replaced with the NIC name for your EtherCAT network.
This will first attempt to discover EtherCAT nodes on the network. If it finds any, it will (using the ESI
files) generate the ENI file, EtherCAT.xml. If you have added any ESI
files to the ESI
directory, you may need to delete the ESICache.xml
file to force a refresh.
To check the RMP serial number, use:
--cpu-affinity
and the Primary NIC (for RMP network) --primary-nic
. See MotionController CreationParameters. Where {YOUR_CPU_INDEX} should be replaced with the CPU core index where RMP should run and {YOUR_NIC_NAME} should be replaced with the NIC name for your EtherCAT network.
If 0
is returned, the serial number cannot be found.
--verbose
to see errors, which will help you identify the unlicensed RMP serial number.To check the RMP license, use:
--cpu-affinity
and the Primary NIC (for RMP network) --primary-nic
. See MotionController CreationParameters. Where {YOUR_CPU_INDEX} should be replaced with the CPU core index where RMP should run and {YOUR_NIC_NAME} should be replaced with the NIC name for your EtherCAT network.
Returns True
if the license is valid, False
if not.
--verbose
to see errors.