Skip to content

Commit

Permalink
huge fix for russian names, tocs and links
Browse files Browse the repository at this point in the history
  • Loading branch information
Atarity committed May 7, 2014
1 parent f8ae179 commit 7f6cdd3
Show file tree
Hide file tree
Showing 9 changed files with 70 additions and 31 deletions.
2 changes: 1 addition & 1 deletion EN/Prismatik_API.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# API
# Prismatik API description

_This document describes low-level API (documentation is valid for API ver. 1.3), which allows to control the device with the help of external software and plugins via sockets mechanism._

Expand Down
2 changes: 1 addition & 1 deletion RUS/RPi+XBMC.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### Raspberry Pi, Raspbmc, Boblight и Lightpack
# Дружим Raspberry Pi, Raspbmc, Boblight и Lightpack

### Требуемые программы и утилиты:

Expand Down
9 changes: 7 additions & 2 deletions RUS/Описание_Prismatik_API.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# API
# Описание Prismatik API

_Документ описывает "низкоуровневый" API (документация актуальна для версии API 1.4), который позволяет управлять устройством из внешних программ и плагинов через механизм сокетов._

----------------
_Содержание:_

* [help](#help)
* [exit](#exit)
Expand Down Expand Up @@ -28,7 +33,7 @@
* [newprofile](#newprofile)
* [deleteprofile](#deleteprofile)

Документ описывает "низкоуровневый" API (документация актуальна для версии API 1.4), который позволяет управлять устройством из внешних программ и плагинов через механизм сокетов. Фактически, из любой ОС, вы можете подключиться через терминал и посылать устройству команды в режиме реального времени.
Фактически, из любой ОС, вы можете подключиться через терминал и посылать устройству команды в режиме реального времени.

<pre>
>> telnet 127.0.0.1 3636
Expand Down
46 changes: 38 additions & 8 deletions RUS/Описание_pyLightpack.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,38 @@
#pyLightpack
#Описание Pytnon-обёртки pyLightpack
_Описание класса-обёртки для языка Python, который сильно упрощает работу с API Лайтпака_

-----------
_Содержание:_

- [Введение](#Введение)
- [Структура Python-скрипта](#Структура-Python-скрипта)
- [Базовые методы](#Базовые-методы)
- [lightpack.lightpack()](#lightpacklightpack)
- [connect()](#connect)
- [lock()](#lock)
- [unlock()](#unlock)
- [disconnect()](#disconnect)
- [GET-методы](#GET-методы)
- [getProfile()](#getProfile)
- [getProfiles()](#getProfiles)
- [getStatus()](#getStatus)
- [getAPIStatus()](#getAPIStatus)
- [getCountLeds()](#getCountLeds)
- [SET-методы](#SET-методы)
- [turnOn()](#turnOn)
- [turnOff()](#turnOff)
- [setProfile()](#setProfile)
- [setColor()](#setColor)
- [setColorToAll()](#setColorToAll)
- [setGamma()](#setGamma)
- [setSmooth()](#setSmooth)
- [setBrightness](#setBrightness)
- [Пример использования](#Пример-использования)



##Введение
pyLightpack — это набор определений и методов для языка [Python](http://ru.wikipedia.org/wiki/Python), которые сильно упрощают процесс взаимодействия с API и написание плагинов для Лайтпака. Например, код простейшего скрипта, который будет плавно включать и гасить ярко-зелёную подсветку может выглядеть так:
pyLightpack — это набор определений и методов для языка [Python](https://www.python.org), которые сильно упрощают процесс взаимодействия с API и написание плагинов для Лайтпака. Например, код простейшего скрипта, который будет плавно включать и гасить ярко-зелёную подсветку может выглядеть так:

```python
import lightpack, time # Подключаем необходимые внешние модули
Expand All @@ -19,17 +49,17 @@ while True :
time.sleep(1)
```

"Живьём" этот и [некоторые другие](http://code.google.com/p/lightpack/source/browse/Software/apiexamples/Animexamples.py) выполненные на скорую руку эффекты выглядят так:
"Живьём" этот и [некоторые другие](https://github.com/Atarity/Lightpack/tree/master/Software/apiexamples/pyLightpack) выполненные на скорую руку эффекты выглядят так:

[<img src="http://img.youtube.com/vi/yUoRsVsyFEo/0.jpg">](http://www.youtube.com/watch?feature=player_embedded&v=yUoRsVsyFEo)

Этот документ содержит описание методов и некоторые примеры работы с ними. Для начала работы, неплохо было бы кратко ознакомиться с возможностями [API](http://code.google.com/p/lightpack/wiki/API), установить [Python 2.7](http://www.python.org/download/), положить файл [lightpack.py](http://code.google.com/p/lightpack/source/browse/Software/apiexamples/pyLightpack/lightpack.py) в одну папку с вашим будущим скриптом-плагином. Если Python для вас в новинку, то есть смысл держать под рукой один из [справочников-туториалов](http://wiki.python.org/moin/BeginnersGuide). Этот язык крайне гибок, но некоторые синтаксические конструкции могут казаться на первый взгляд неочевидными.
Этот документ содержит описание методов и некоторые примеры работы с ними. Для начала работы, неплохо было бы кратко ознакомиться с возможностями [API Призматика](https://github.com/Atarity/Lightpack-docs/blob/master/RUS/%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_Prismatik_API.md), установить [Python 2.7](http://www.python.org/download/), положить файл [lightpack.py](https://github.com/Atarity/Lightpack/tree/master/Software/apiexamples/pyLightpack) в одну папку с вашим будущим скриптом-плагином. Если Python для вас в новинку, то есть смысл держать под рукой один из [справочников-туториалов](http://wiki.python.org/moin/BeginnersGuide). Этот язык крайне гибок, но некоторые синтаксические конструкции могут казаться на первый взгляд неочевидными.

Если читать справку лень, а запустить скрипт хочется, то для совсем быстрого старта помимо вышеописанных рекомендаций нужно проделать следующее:

1. После установки Питона проследить за тем, чтобы файлы .py были ассоциированы с интерпретатором (происходит по умолчанию)
2. Запустить управляющий софт Лайтпака свежих версий, которые поддерживают API
3. Для Win выполнить **run—>cmd** запустив тем самым консоль
3. Для Win выполнить **run &rarr; cmd** запустив тем самым консоль
4. Посредством команд `/cd` (или любых удобных вам) перебраться в рабочую папку скрипта в которой обязательно должен находиться **lightpack.py**, как написано выше
5. Выполнить `/moi_script.py`

Expand All @@ -49,9 +79,9 @@ while True :
< unlock() или disconnect() >
```

При этом у вас остаётся возможность использовать всю мощь и гибкость Питона вкупе с бездной внешних модулей для него. При этом плагины существуют параллельно с режимами управляющего софта Лайтпака (см. метод **lock()**) и не исключают друг друга. В нашем репозитории некоторые примеры плагинов с использованием pyLightpack находятся в [соответствующей папке](http://code.google.com/p/lightpack/source/browse/Software/apiexamples/).
При этом у вас остаётся возможность использовать всю мощь и гибкость Питона вкупе с бездной внешних модулей для него. При этом плагины существуют параллельно с режимами управляющего софта Лайтпака (см. метод **lock()**) и не исключают друг друга. В нашем репозитории некоторые примеры плагинов с использованием pyLightpack находятся в [соответствующей папке](https://github.com/Atarity/Lightpack/tree/master/Software/apiexamples/pyLightpack).

Если по каким-то причинам Python вас не устраивает, вы можете работать напрямую с ["низкоуровневым" API](http://code.google.com/p/lightpack/wiki/API), или даже написать собственную обёртку (wrapper) под любимый язык. Если так, то не забудьте поделиться ей с нами.)
Если по каким-то причинам Python вас не устраивает, вы можете работать напрямую с ["низкоуровневым" API](https://github.com/Atarity/Lightpack-docs/blob/master/RUS/%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_Prismatik_API.md), или даже написать собственную обёртку (wrapper) под любимый язык. Если так, то не забудьте поделиться ей с нами.)

##Базовые методы
Описание основных методов необходимых для подключения к API и управления приоритетами.
Expand Down Expand Up @@ -156,7 +186,7 @@ if lpack.getAPIStatus() == 'idle' :
lpack.lock()
...
```
####getCountLeds()
###getCountLeds()
_Возвращаемые значения: **кол-во зон захвата**_

Возвращает общее количество всех зон захвата (активных и отключенных) в текущем профиле. Актуально для устройств типа Adalight для которых программа позволяет устанавливать произвольное количество зон захвата.
Expand Down
18 changes: 11 additions & 7 deletions RUS/Описание_настроек_Призматика.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
### Описание параметров
# Описание настроек Призматика

_На этой странице описаны настройки, которые доступны пользователю через соответствующий пункт контекстного меню программы (иконка в системном трее). Из-за частого обновления модуля захвата некоторые из этих пунктов могут быть недоступны в свежей версии программы. Другие могут быть вынесены в конфигурационный текстовый файл профиля или глобальный профиль main.conf . Тем не менее, мы стараемся поддерживать страницу в актуальном состоянии и следить за корректностью описания настроек._

---------------

_Содержание:_

* [Настройки режимов](#Настройки-режимов)
* [Режим захвата картинки](#Режим-захвата-картинки)
* [Частота захвата](#Частота-захвата)
* [Захватывать каждые (задержка захвата)](#%D0%97%D0%B0%D1%85%D0%B2%D0%B0%D1%82%D1%8B%D0%B2%D0%B0%D1%82%D1%8C-%D0%BA%D0%B0%D0%B6%D0%B4%D1%8B%D0%B5-%D0%B7%D0%B0%D0%B4%D0%B5%D1%80%D0%B6%D0%BA%D0%B0-%D0%B7%D0%B0%D1%85%D0%B2%D0%B0%D1%82%D0%B0)
* [Захватывать каждые (задержка захвата)](#Захватывать-каждые-задержка-захвата)
* [Средний цвет на все светодиоды](#Средний-цвет-на-все-светодиоды)
* [Порог освещённости сцены](#Порог-освещённости-сцены)
* [Внешний вид виджетов](#Внешни-вид-виджетов)
Expand All @@ -13,21 +19,19 @@
* [Настройки устройства](#Настройки-устройства)
* [Общая яркость](#Общая-яркость)
* [Гамма-коррекция](#Гамма-коррекция)
* [Оставлять подсветку включённой-после-выхода](#)
* [Оставлять подсветку включённой после выхода](#Оставлять-подсветку-включённой-после-выхода)
* [Плавность переходов](#Плавность-переходов)
* [Профили](#Профили)
* [Профиль](#Профиль)
* [Язык](#Язык)
* [Показывать дополнительные настройки](#Показывать-дополнительные-настройки)
* [Плагины](#Плагины)
* [Список доступных плагинов](#Список-доступных-плагинов)
* [Консоль Python](#Консоль-Python)
* [Консоль Python](#Консоль-python)
* [Перезагрузить плагины](#Перезагрузить-плагины)
* [Лаборатория](#Лаборатория)
* [Настройка цветового баланса светодиодов](#Настройка-цветового-баланса-светодиодов)

На этой странице описаны настройки, которые доступны пользователю через соответствующий пункт контекстного меню программы (иконка в системном трее). Из-за частого обновления модуля захвата некоторые из этих пунктов могут быть недоступны в свежей версии программы. Другие могут быть вынесены в конфигурационный текстовый файл профиля или глобальный профиль main.conf . Тем не менее, мы стараемся поддерживать страницу в актуальном состоянии и следить за корректностью описания настроек.

Если вы уже ознакомились с принципами работы устройства, то многие вопросы по настройке, наверняка, отпали сами собой. Так же есть смысл ознакомится с некоторыми советами по настройке софта, которые мы описали на основе собственного опыта (часть из них уже успела устареть -- смотрите на дату публикации).

Окно настроек программы содержит 5 разделов (6, если у вас включен расширенный интерфейс). Рассмотрим их подробнее.
Expand Down Expand Up @@ -83,7 +87,7 @@

### Профили

Начиная с версии 4.1.0 программа захвата поддерживает профили настроек управлять которыми можно с этой страницы. Каждый отдельный профиль является конфигурационным файлом с расширением .ini, который хранится в папке \Profiles директории профиля Призматика, например C:\Documents and Settings\Atarity\Prismatik\Profiles.
Начиная с версии 4.1.0 программа захвата поддерживает профили настроек управлять которыми можно с этой страницы. Каждый отдельный профиль является конфигурационным файлом с расширением `.ini`, который хранится в папке `\Profiles` директории профиля Призматика, например `C:\Documents and Settings\Atarity\Prismatik\Profiles`.

![Профили](http://store.pixelkit.ru/img/Prismatik/ru-3-profiles.jpg)

Expand Down
2 changes: 1 addition & 1 deletion RUS/Призматик_для_Android.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#Призматик для Android
*В этом документе описаны особенности работы и опции приложения Призматик для операционной системы Андроид. Если вы уже ознакомились с принципами работы устройства, то наверняка большинство вопросов по использованию Призматика отпало само собой. В любом случае мы постарались описать все настройки предельно коротко и ясно, снабдив скриншотами все важные места.*
*В этом документе описаны особенности работы и опции приложения Призматик для операционной системы Андроид. Если вы уже ознакомились с [принципами работы устройства](https://github.com/Atarity/Lightpack-docs/blob/master/RUS/%D0%9F%D1%80%D0%B8%D0%BD%D1%86%D0%B8%D0%BF_%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%8B.md), то наверняка большинство вопросов по использованию Призматика отпало само собой. В любом случае мы постарались описать все настройки предельно коротко и ясно, снабдив скриншотами все важные места.*

----------------------
*Содержание:*
Expand Down
Loading

0 comments on commit 7f6cdd3

Please sign in to comment.