TrObject

class TrObject(obj)[исходный код]

Вспомогательный класс для работы с объектами Trassir

obj

Объект trassir object('{guid}') или None

Type:SE_Object
obj_methods

Список методов объекта TrObject.obj

Type:List[str]
name

Имя объекта или его guid

Type:str
guid

Guid объекта

Type:str
full_guid

Полный guid {guid объекта}_{guid сервера} или None

Type:str
type

Тип объекта, например "RemoteServer", "Channel", "Grabber", "User", и др.

Type:str
path

Путь в настройках или None

Type:str
parent

Guid родительского объекта или None

Type:str
server

Guid сервера или None

Type:str
settings

Объект настроек settings('{path}') или None

Type:SE_Settings
Raises:
  • TypeError – Если неправильные параметры объекта
  • ValueError – Если в имени объекта есть запятые

Servers

class Servers[исходный код]

Класс для работы с серверами

Examples

>>> srvs = Servers()
>>> local_srv = srvs.get_local()
[TrObject('Клиент')]
>>> # Првоерим "Здоровье" локального сервера
>>> local_srv[0].obj.state("server_health")
'Health Problem'
get_local()[исходный код]

Возвращает локальный сервер (на котором запущен скрипт)

Результат:Список объектов
Тип результата:List[TrObject]
get_remote()[исходный код]

Возвращает список удаленных серверов

Результат:Список объектов
Тип результата:List[TrObject]
get_all()[исходный код]

Возвращает список всех доступных серверов

Результат:Список объектов
Тип результата:List[TrObject]

Persons

class Persons(server_guid=None)[исходный код]

Класс для работы с персонами и их папками.

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> persons = Persons()
>>> persons.get_folders()
[TrObject('Мошенники'), TrObject('DSSL'), TrObject('persons')]
>>> persons.get_persons()
[
    {
        'name': 'Leonardo',
        'guid': 'cJuJYAha',
        'gender': 0,
        'birth_date': '1980-01-01',
        'comment': 'Comment',
        'contact_info': 'Contact info',
        'folder_guid': 'n68LOBhG',
        'image': <image, str>,
        'image_guid': 'gBHZ2vpz',
        'effective_rights': 0,
    },
    ...
]
>>> persons.get_person_by_guid("cJuJYAha")
{
    'name': 'Leonardo',
    'guid': 'cJuJYAha',
    'gender': 0,
    'birth_date': '1980-01-01',
    'comment': 'Comment',
    'contact_info': 'Contact info',
    'folder_guid': 'n68LOBhG',
    'image': <image, str>,
    'image_guid': 'gBHZ2vpz',
    'effective_rights': 0,
}
get_folders(names=None)[исходный код]

Возвращает список папок персон

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_persons(folder_names=None, timeout=10)[исходный код]

Возвращает список персон

Примечание

Данный метод работает только с локальной БД.

Параметры:
  • folder_names (str | List[str], optional) – str - названия папок персон, разделенные запятыми или list - список папок персон. По умолчанию None
  • timeout (int, optional) – Макс. время запроса к БД. По умолчанию timeout=10
Результат:

Список персон - если персоны найдены

Тип результата:

List[dict]

Raises:
  • EnvironmentError – Если произошла ошибка при запросе в БД.
  • TrassirError – Если в данной сборке Trassir нет метода host_ip.service_persons_get
get_person_by_guid(person_guid, timeout=10)[исходный код]

Возвращает информацию о персоне по его guid

Примечание

Для уменьшения кол-ва запросов к БД - метод создает локальную копию всех персон при первом запросе и обновляет ее вместе с последующими запросами не чаще чем 1 раз в 10 минут.

Параметры:
  • person_guid (str) – Guid персоны
  • timeout (int, optional) – Макс. время запроса к БД. По умолчанию timeout=10
Результат:

Даные о персоне или None если персона не найдена

Тип результата:

dict

get_person_by_name(person_name, timeout=10)[исходный код]

Возвращает информацию о персоне по его имени

Примечание

Для уменьшения кол-ва запросов к БД - метод создает локальную копию всех персон при первом запросе и обновляет ее вместе с последующими запросами не чаще чем 1 раз в 10 минут.

Параметры:
  • person_name (str) – Имя персоны
  • timeout (int, optional) – Макс. время запроса к БД. По умолчанию timeout=10
Результат:

Даные о персоне или None если персона не найдена

Тип результата:

dict

Users

class Users(server_guid=None)[исходный код]

Класс для работы с пользователями и их группами.

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> users = Users()
>>> users.get_groups()
[TrObject('TEST')]
get_groups(names=None)[исходный код]

Возвращает список групп пользователей

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_users(names=None)[исходный код]

Возвращает список пользователей

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_users_by_groups(group_names)[исходный код]

Возвращает список пользователей из указанных групп

Параметры:group_names (str | list) – str - имена групп, разделенные запятыми или list - список имен.
Результат:Список объектов
Тип результата:List[TrObject]

Templates

class Templates(server_guid=None)[исходный код]

Класс для работы с существующими шаблонами.

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> templates = Templates(BaseUtils.get_server_guid())
>>> templates.get_all()
[TrObject('Parking'), TrObject('FR'), TrObject('AT'), TrObject('AD+')]
get_all(names=None)[исходный код]

Возвращает список шаблонов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

PosTerminals

class PosTerminals(server_guid=None)[исходный код]

Класс для работы с POS Терминалами

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> pos_terminals = PosTerminals()
>>> pos_terminals.get_disabled()
[TrObject('Касса (1)')]
get_enabled(names=None)[исходный код]

Возвращает список активных POS Терминалов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_disabled(names=None)[исходный код]

Возвращает список неактивных POS Терминалов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_all(names=None)[исходный код]

Возвращает список всех POS Терминалов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

Devices

class Devices(server_guid=None)[исходный код]

Класс для работы с ip устройствами

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> devices = Devices()
>>> enabled_devices = devices.get_enabled()
>>> enabled_devices
[TrObject('AC-D2121IR3W'), TrObject('AC-D5123IR32'), ...]
>>>
>>> # Перезагрузим все устройства
>>> for dev in enabled_devices:
...     dev.settings["reboot"] = 1
get_enabled(names=None)[исходный код]

Возвращает список активных устройств

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_disabled(names=None)[исходный код]

Возвращает список неактивных устройств

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_all(names=None)[исходный код]

Возвращает список всех устройств

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

Channels

class Channels(server_guid=None)[исходный код]

Класс для работы с каналами

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> channels = Channels()
>>> selected_channels = channels.get_enabled("AC-D2121IR3W 2,AC-D9141IR2 1")
>>> selected_channels
[TrObject('AC-D2121IR3W 2'), TrObject('AC-D9141IR2 1')]
>>>
>>> # Включим ручную запись на выбранных каналах
>>> for channel in selected_channels:
...     channel.obj.manual_record_start()
>>>
>>> # Или добавим к имени канала его guid
>>> for channel in selected_channels:
...     channel.settings["name"] += " ({})".format(channel.guid)
get_enabled(names=None)[исходный код]

Возвращает список активных каналов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_disabled(names=None)[исходный код]

Возвращает список неактивных каналов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_all(names=None)[исходный код]

Возвращает список всех каналов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

NetworkNodes

class NetworkNodes(server_guid=None)[исходный код]

Класс для работы с сетевыми подключениями

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> network_nodes = NetworkNodes("client")
>>> network_nodes.get_enabled()
[TrObject('QuattroStationPro (172.20.0.101)'), TrObject('NSK-HD-01 (127.0.0.1)')]
get_enabled(names=None)[исходный код]

Возвращает список активных сетевых подключений

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_disabled(names=None)[исходный код]

Возвращает список неактивных сетевых подключений

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_all(names=None)[исходный код]

Возвращает список всех сетевых подключений

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

Rules

class Rules(server_guid=None)[исходный код]

Класс для работы с правилами

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> rules = Rules()
>>> all_rules = rules.get_all()
>>> all_rules
[TrObject('!Rule'), TrObject('NEW RULE'), TrObject('Новое правило')]
>>>
>>> # Отключим все правила
>>> for rule in all_rules:
...     rule.settings["enable"] = 0
get_enabled(names=None)[исходный код]

Возвращает список активных правил

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_disabled(names=None)[исходный код]

Возвращает список неактивных правил

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_all(names=None)[исходный код]

Возвращает список всех правил

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

Scripts

class Scripts(server_guid=None)[исходный код]

Класс для работы со скриптами

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> scripts = Scripts()
>>> all_scripts = scripts.get_all()
>>> all_scripts
[TrObject('Новый скрипт'), TrObject('HDD Health Monitor'), TrObject('Password Reminder')]
>>>
>>> # Отключим все скрипты
>>> for script in all_scripts:
...     script.settings["enable"] = 0
get_enabled(names=None)[исходный код]

Возвращает список активных скриптов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_disabled(names=None)[исходный код]

Возвращает список неактивных скриптов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_all(names=None)[исходный код]

Возвращает список всех скриптов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

StockScripts

class StockScripts(server_guid=None)[исходный код]

Класс для работы со встроенными скриптами

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> stock_scripts = StockScripts()
>>> all_scripts = stock_scripts.get_all()
>>> all_scripts
[TrObject('MegaRAID Monitor')]
>>>
>>> # Отключим все скрипты
>>> for script in all_scripts:
...     script.settings["enable"] = 0
get_enabled(names=None)[исходный код]

Возвращает список активных скриптов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_disabled(names=None)[исходный код]

Возвращает список неактивных скриптов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_all(names=None)[исходный код]

Возвращает список всех скриптов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

Schedules

class Schedules(server_guid=None)[исходный код]

Класс для работы с расписаниями

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> schedules = Schedules()
>>> my_schedule = schedules.get_enabled("!Schedule")[0]
>>> my_schedule.obj.state("color")
'Red'
on_load(schedule_name, callback, tries=5)[исходный код]

Вызывает callback после загрузки расписания

Примечание

При загрузке сервера, объект расписания становится не сразу доступен. Данный метод помогает предотвратить данную ошибку.

Параметры:
  • schedule_name (str) – Имя расписания
  • callback (function) – Функция, которая вызывается после загрузки расписания.
  • tries (int, optional) – Кол-во попыток загрузки расписания. Каждая попытка производится с интервалом 1 с. По умолчанию 5
Examples
>>> schedule = None
>>> # noinspection PyGlobalUndefined,PyUnresolvedReferences
>>> def on_schedule_loaded(schedule_obj):
...     global schedule
...     schedule = schedule_obj
...
...     message("Schedule '{obj.name}' ({obj.guid}) loaded".format(obj=schedule))
...     schedule.activate_on_state_changes(lambda: alert(schedule.state("color")))
>>>
>>> Schedules().on_load("Unnamed Schedule", on_schedule_loaded)
get_enabled(names=None)[исходный код]

Возвращает список активных расписаний

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_disabled(names=None)[исходный код]

Возвращает список неактивных расписаний

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_all(names=None)[исходный код]

Возвращает список всех расписаний

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

EmailAccounts

class EmailAccounts(server_guid=None)[исходный код]

Класс для работы с E-Mail аккаунтами

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> email_accounts = EmailAccounts()
>>> email_accounts.get_all()
[TrObject('Новая учетная запись e-mail'), TrObject('MyAccount')]
get_all(names=None)[исходный код]

Возвращает список всех E-Mail аккаунтов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

TemplateLoops

class TemplateLoops(server_guid=None)[исходный код]

Класс для работы с циклическими просмотрами шаблонов

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> tmplate_loops = TemplateLoops()
>>> tmplate_loops.get_all()
[TrObject('Новый циклический просмотр')]
get_enabled(names=None)[исходный код]

Возвращает список активных циклических просмотров шаблонов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_disabled(names=None)[исходный код]

Возвращает список неактивных циклических просмотров шаблонов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_all(names=None)[исходный код]

Возвращает список всех циклических просмотров шаблонов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

GPIO

class GPIO(server_guid=None)[исходный код]

Класс для работы с тревожными входами/выходами

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> gpio = GPIO()
>>> gpio_door = gpio.get_inputs("Door")[0]
>>> gpio_door.obj.state("gpio_input_level")
'Input Low (Normal High)'
>>> gpio_light = gpio.get_outputs("Light")[0]
>>> gpio_light.obj.set_output_high()
get_inputs(names=None)[исходный код]

Возвращает список тревожных входов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_outputs(names=None)[исходный код]

Возвращает список тревожных выходов

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

Zones

class Zones(server_guid=None)[исходный код]

Класс для работы с зонами

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> zones = Zones()
>>> zones.get_queues("Касса 1")[0].obj.state("zone_queue")
'5+'
get_people(names=None)[исходный код]

Возвращает список PeopleZones

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_simt(names=None)[исходный код]

Возвращает список зон SIMT

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_workplaces(names=None)[исходный код]

Возвращает список рабочих зон

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_queues(names=None)[исходный код]

Возвращает список зон очередей

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_shelves(names=None)[исходный код]

Возвращает список зон полок

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]

Borders

class Borders(server_guid=None)[исходный код]

Класс для работы с линиями пересечения

Параметры:server_guid (str | List[str], optional) – Guid сервера или список guid. По умолчанию None, что соотвествует всем доступным серверам.

Examples

>>> borders = Borders()
>>> borders.get_simt()
[TrObject('DBOP')]
>>> borders.get_all()
[TrObject('Вход в офис'), TrObject('DBOP')]
get_head(names=None)[исходный код]

Возвращает список HeadBorders

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_people(names=None)[исходный код]

Возвращает список PeopleBorders

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_simt(names=None)[исходный код]

Возвращает список SIMT Borders

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_deep_people(names=None)[исходный код]

Возвращает список DeepPeopleBorders

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]
get_all(names=None)[исходный код]

Возвращает список всех линий пересечения

Параметры:names (str | list, optional) – str - имена, разделенные запятыми или list - список имен. По умолчанию None
Результат:Список объектов
Тип результата:List[TrObject]