isecnet-go

command module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 2, 2021 License: Apache-2.0 Imports: 1 Imported by: 0

README

FOSSA Status

This an go SDK implementation for Intelbras' ISECNet protocol.

ISEcnet

ISECnet is a proprietary protocol used by Intelbras in their alarm central communication.

Usage

Available Commands

  help          Help about any command
  partialStatus Get partial central status
  zones         Get Zone status

Example

Example of the zones and zones -w command running in the terminal

Zones description

You can configure the zone description in .isecnet-go.yaml to see meaningful names and only zones in use. See .isecnet-go..yaml.example for example:

zones:
  - id: 1
    name: Front Door
    description: Front dor magnetic sensor
➜  isecnet-go git:(main) ✗ go run . --password 1234 zones
Using config file: ./.isecnet-go.yaml
INFO[0000] Connecting...                                 address="localhost:9009"
+------------+----------+-------+----------+------------+--------+---------------+
|    ZONE    | ANULATED | OPEN  | VIOLATED | LOWBATTERY | TAMPER | SHORT CIRCUIT |
+------------+----------+-------+----------+------------+--------+---------------+
| Front Door | false    | false | false    | false      | false  | false         |
+------------+----------+-------+----------+------------+--------+---------------+

Testing

  • make unit-test: unit tests

  • make lint: linter

  • make test: run all

  • make mock-alarm-central: starts the mock server

  • go run . server: starts the gRPC server:

// Testing the API
grpcurl -plaintext localhost:8080 ZoneService.GetZones

References

License

FOSSA Status

Documentation

Overview

Copyright © 2021 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Directories

Path Synopsis
api
pb
internal
app
pkg
alarm/mock_alarm
Package mock_alarm is a generated GoMock package.
Package mock_alarm is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL