Dictionary¶
-
class
ingenialink.ipb.dictionary.
IPBCategories
(ipb_dictionary)[source]¶ IPB Categories for the dictionary.
- Parameters
ipb_dictionary (IPBDictionary) – Ingenia dictionary instance.
-
labels
(category_id)[source]¶ Obtain labels for a certain category ID.
- Returns
Labels dictionary.
- Return type
dict
-
property
category_ids
¶ Obtain all Category Identifiers.
- Returns
Category IDs.
- Return type
list
-
class
ingenialink.ipb.dictionary.
IPBDictionary
(dictionary_path, cffi_servo)[source]¶ IPB Ingenia Dictionary.
- Parameters
dictionary_path (str) – Dictionary file name.
cffi_servo (CData) – CFFI instance of the current Servo.
- Raises
ILCreationError – If the dictionary could not be created.
-
registers
(subnode)[source]¶ Obtain all the registers of a subnode.
- Parameters
subnode (int) – Subnode.
- Returns
List of registers.
- Return type
array
-
categories
¶ Instance of all the categories in the dictionary.
- Type
Categories
-
errors
¶ Instance of all the errors in the dictionary.
- Type
Errors
-
firmware_version
¶ Firmware version declared in the dictionary.
- Type
str
-
interface
¶ Interface declared in the dictionary.
- Type
str
-
part_number
¶ Part number declared in the dictionary.
- Type
str
-
path
¶ Path of the dictionary.
- Type
str
-
product_code
¶ Product code declared in the dictionary.
- Type
int
-
revision_number
¶ Revision number declared in the dictionary.
- Type
int
-
subnodes
¶ Number of subnodes in the dictionary.
- Type
int
-
version
¶ Version of the dictionary.
- Type
str
-
class
ingenialink.ipb.dictionary.
IPBErrors
(dict_)[source]¶ Errors for the IPB dictionary.
- Parameters
dict (str) – Path to the Ingenia dictionary.
-
class
ingenialink.ipb.dictionary.
IPBRegistersDictionary
(dict_, subnode)[source]¶ Registers dictionary.
- Parameters
dict (CData) – Ingenia dictionary instance.
-
get
(k[, d]) → D[k] if k in D, else d. d defaults to None.¶
-
items
() → a set-like object providing a view on D’s items¶
-
keys
() → a set-like object providing a view on D’s keys¶
-
values
() → an object providing a view on D’s values¶
-
class
ingenialink.ipb.dictionary.
IPBSubCategories
(dict_, cat_id)[source]¶ Sub-categories.
- Parameters
dict (CData) – Ingenia dictionary instance.
cat_id (str) – Category ID.
-
labels
(scat_id)[source]¶ Obtain labels for a certain sub-category identifiers.
- Returns
Labels dictionary.
- Return type
dict
-
property
subcategory_ids
¶ Obtain all sub-category identifiers.
- Returns
Sub-category identifiers.
- Return type
list