Plugins Python API¶

All SocExplorer plugins expose some common functions and their own functions to the embedded Python terminal.

Common Functions¶

All this functions are either implemented in the base class socexplorerplugin or in the plugin itself.

Function list:

• QVariantList Read (unsigned int address, unsigned int count);
• void Write (unsigned int address, QList<QVariant> dataList);
• void closeMe ();
• void activate (bool flag);
• void setInstanceName (const QString & newName);
• bool dumpMemory (unsigned int address, unsigned int count, QString file);
• bool memSet (unsigned int address, int value, unsigned int count);
• bool loadbin (unsigned int address, QString file);
• bool loadfile (abstractBinFile * file);
• bool dumpMemory (unsigned int address, unsigned int count, QString file, const QString & format);

---

---

QVariantList Read (unsigned int address, unsigned int count)¶

Reads target memory at given address and return its content. On any root plugin it will read system memory and by default on child plugin it will forward request to parent plugin util it reach root plugin and read system bus.
Note that this function could be re-implemented on a child plugin and have a different behavior.

The returned list is a Word list which means that the smallest data you can read is a word(32 bits) and count is the number of words to read. The function respect host endianness so it will convert data depending on target endianness.

void Write (unsigned int address, QList<QVariant> dataList)¶

void closeMe ()¶

void activate (bool flag)¶

void setInstanceName (const QString & newName)¶

bool dumpMemory (unsigned int address, unsigned int count, QString file)¶

bool memSet (unsigned int address, int value, unsigned int count)¶

bool loadbin (unsigned int address, QString file)¶

bool loadfile (abstractBinFile * file)¶

bool dumpMemory (unsigned int address, unsigned int count, QString file, const QString & format)¶