API Reference (python)

API Reference (python)

ipcx.IPC

class ipcx.IPC(node)

This class creates node in ROS.

• Parameter:

  • node: [string] - A node is a process that performs computation

method:

isRun()

isRun check IPC is running or not

• Parameter: -
• Return: [boolean] - True for running, False for not running

spin()

spin create loop

• Parameter: -
• Return: -

off()

stop spin and shutdown ipc

• Parameter: -
• Return: -

---

class ipcx.server(topic) This class will initialize server that public topic

method

publish(message,show = "off")

publish will publish message through the pipe that is called topic. if you subscribe, you can get the meesage.

• Parameter:
  • message : [string]
  • show : [string] setting show send message. "off" for off showing message (default) and "on" for showing message
• Return: -

---

class ipcx.client(topic,callback = None) This class will initialize client that subscribe topic