Skip to content

Commit

Permalink
Fix #2 - Cleaned README
Browse files Browse the repository at this point in the history
  • Loading branch information
@elad-bar
elad-bar committed May 16, 2021
1 parent eab66d2 commit 7326d55
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 26 deletions.
22 changes: 11 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Integration with Shinobi Video NVR. Creates the following components:

#### Requirements
- Shinobi Video Server available with credentials
- MQTT Integration is optional - it will allow to listen to BlueIris event
- MQTT Integration is optional - it will allow listening to Shinobi Video event

#### Shinobi links:
- [Using MQTT to receive and trigger events](https://hub.shinobi.video/articles/view/xEMps3O4y4VEaYk)
Expand All @@ -28,23 +28,23 @@ Currently, repository is not under official HACS repo, in order to install, you
Look for "Shinobi Video NVR" and install

#### Integration settings
###### Basic configuration (Configuration -> Integrations -> Add BlueIris)
###### Basic configuration (Configuration -> Integrations -> Add Shinobi Video NVR)
Fields name | Type | Required | Default | Description
--- | --- | --- | --- | --- |
Host | Texbox | + | None | Hostname or IP address of the BlueIris server
Port | Textbox | + | 0 | HTTP Port to access BlueIris server
Host | Texbox | + | None | Hostname or IP address of the Shinobi Video server
Port | Textbox | + | 0 | HTTP Port to access Shinobi Video server
SSL | Check-box | + | Unchecked | Is SSL supported?
Username | Textbox | - | | Username of admin user for BlueIris server
Password | Textbox | - | | Password of admin user for BlueIris server
Username | Textbox | - | | Username of admin user for Shinobi Video server
Password | Textbox | - | | Password of admin user for Shinobi Video server

###### Integration options (Configuration -> Integrations -> BlueIris Integration -> Options)
###### Integration options (Configuration -> Integrations -> Shinobi Video NVR Integration -> Options)
Fields name | Type | Required | Default | Description
--- | --- | --- | --- | --- |
Host | Texbox | + | ast stored hostname | Hostname or IP address of the BlueIris server
Port | Textbox | + | 0ast stored port | HTTP Port to access BlueIris server
Host | Texbox | + | ast stored hostname | Hostname or IP address of the Shinobi Video server
Port | Textbox | + | 0ast stored port | HTTP Port to access Shinobi Video server
SSL | Check-box | + | Last stored SSL flag | Is SSL supported?
Username | Textbox | - | Last stored username | Username of admin user for BlueIris server
Password | Textbox | - | Last stored password | Password of admin user for BlueIris server
Username | Textbox | - | Last stored username | Username of admin user for Shinobi Video server
Password | Textbox | - | Last stored password | Password of admin user for Shinobi Video server
Log level | Drop-down | + | Default | Changes component's log level (more details below)

**Log Level's drop-down**
Expand Down
4 changes: 2 additions & 2 deletions custom_components/shinobi/api/shinobi_api.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def config_data(self):
return self.config_manager.data

async def initialize(self):
_LOGGER.info("Initializing BlueIris")
_LOGGER.info("Initializing Shinobi Video")

try:
config_data = self.config_data
Expand All @@ -87,7 +87,7 @@ async def initialize(self):
line_number = tb.tb_lineno

_LOGGER.error(
f"Failed to initialize BlueIris API ({self.base_url}), error: {ex}, line: {line_number}"
f"Failed to initialize Shinobi Video API ({self.base_url}), error: {ex}, line: {line_number}"
)

def build_url(self, endpoint):
Expand Down
2 changes: 1 addition & 1 deletion custom_components/shinobi/strings.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"step": {
"user": {
"title": "Set up Shinobi Video",
"description": "Set up your BlueIris Server details (to control profiles, fill in valid username and password)",
"description": "Set up your Shinobi Video Server details (to control profiles, fill in valid username and password)",
"data": {
"host": "Host",
"port": "Port",
Expand Down
2 changes: 1 addition & 1 deletion custom_components/shinobi/translations/en.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"step": {
"user": {
"title": "Set up Shinobi Video",
"description": "Set up your BlueIris Server details (to control profiles, fill in valid username and password)",
"description": "Set up your Shinobi Video Server details (to control profiles, fill in valid username and password)",
"data": {
"host": "Host",
"port": "Port",
Expand Down
22 changes: 11 additions & 11 deletions info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Integration with Shinobi Video NVR. Creates the following components:

#### Requirements
- Shinobi Video Server available with credentials
- MQTT Integration is optional - it will allow to listen to BlueIris event
- MQTT Integration is optional - it will allow listening to Shinobi Video event

#### Shinobi links:
- [Using MQTT to receive and trigger events](https://hub.shinobi.video/articles/view/xEMps3O4y4VEaYk)
Expand All @@ -28,23 +28,23 @@ Currently, repository is not under official HACS repo, in order to install, you
Look for "Shinobi Video NVR" and install

#### Integration settings
###### Basic configuration (Configuration -> Integrations -> Add BlueIris)
###### Basic configuration (Configuration -> Integrations -> Add Shinobi Video NVR)
Fields name | Type | Required | Default | Description
--- | --- | --- | --- | --- |
Host | Texbox | + | None | Hostname or IP address of the BlueIris server
Port | Textbox | + | 0 | HTTP Port to access BlueIris server
Host | Texbox | + | None | Hostname or IP address of the Shinobi Video server
Port | Textbox | + | 0 | HTTP Port to access Shinobi Video server
SSL | Check-box | + | Unchecked | Is SSL supported?
Username | Textbox | - | | Username of admin user for BlueIris server
Password | Textbox | - | | Password of admin user for BlueIris server
Username | Textbox | - | | Username of admin user for Shinobi Video server
Password | Textbox | - | | Password of admin user for Shinobi Video server

###### Integration options (Configuration -> Integrations -> BlueIris Integration -> Options)
###### Integration options (Configuration -> Integrations -> Shinobi Video NVR Integration -> Options)
Fields name | Type | Required | Default | Description
--- | --- | --- | --- | --- |
Host | Texbox | + | ast stored hostname | Hostname or IP address of the BlueIris server
Port | Textbox | + | 0ast stored port | HTTP Port to access BlueIris server
Host | Texbox | + | ast stored hostname | Hostname or IP address of the Shinobi Video server
Port | Textbox | + | 0ast stored port | HTTP Port to access Shinobi Video server
SSL | Check-box | + | Last stored SSL flag | Is SSL supported?
Username | Textbox | - | Last stored username | Username of admin user for BlueIris server
Password | Textbox | - | Last stored password | Password of admin user for BlueIris server
Username | Textbox | - | Last stored username | Username of admin user for Shinobi Video server
Password | Textbox | - | Last stored password | Password of admin user for Shinobi Video server
Log level | Drop-down | + | Default | Changes component's log level (more details below)

**Log Level's drop-down**
Expand Down

0 comments on commit 7326d55

Please sign in to comment.