Digi IX40 User Manual page 662

Applications
Task one: Use the device_request module on your IX40 device to create a response
1. Select a device in Remote Manager that is configured to allow shell access to the admin user,
and click Actions > Open Console. Alternatively, log into the IX40 local command line as a user
with shell access.
Depending on your device configuration, you may be presented with an Access selection
menu. Type shell to access the device shell.
2. At the shell prompt, use the python command with no parameters to enter an interactive
Python session:
# python
Python 3.10.1 (main, Mar 30 2023, 23:47:13) [GCC 11.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
3. Import the device_request module:
>>> from digidevice import device_request
>>>
4. Create a function to handle the request from Remote Manager:
>>> def handler(target, request):
print ("received request %s for target %s" % (request, target))
return "OK"
>>>
5. Register a callbackup function that will be called when the device receives a SCI request from
Remote Manager:
>>> device_request.register("myTarget", handler)
>>>
Note Leave the interactive Python session active while completing task two, below. Once you have
completed task two, exit the interactive session by using Ctrl-D. You can also exit the session using
exit() or quit().
Task two: Create and send an SCI request from Digi Remote Manager
The second step in using the device_request module is to create an SCI request that Remote Manager
will forward to the device. For example, you can create in SCI request a the Remote Manager API
explorer:
1. In Remote Manager, click Documentation > API Explorer.
2. Select the device to use as the SCI target:
a. Click SCI Targets.
b. Click Add Targets.
c. Enter or select the device ID of the device.
d. Click Add.
e. Click OK.
IX40 User Guide
Develop Python applications
662