Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@starkillerOG
starkillerOG committed Dec 4, 2020
1 parent 84dabc2 commit 740859a
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,17 +160,18 @@ A gateway device (that was asigned to variable 'm') has the following methods an
## Blind device
A blind device (that was asigned to variable 'blind_1') has the following methods and properties:

| method | arguments | argument type | explanation |
| ------------------------------------- | ------------ | ---------------- | ----------------------------------------------------------------- |
| "blind_1.Update()" | - | - | Get the status of the blind from the Motion Gateway |
| "blind_1.Stop()" | - | - | Stop the motion of the blind |
| "blind_1.Open()" | - | - | Open the blind/move the blind up |
| "blind_1.Close()" | - | - | Close the blind/move the blind down |
| "blind_1.Set_position(50)" | postion | int (0-100) | Set the position of the blind |
| "blind_1.Set_angle(90)" | angle | int (0-180) | Set the angle/rotation of the blind |
| "blind_1.Register_callback("1", func) | id, callback | string, function | Register a external callback function for updates of the blind |
| "blind_1.Remove_callback("1") | id | string | Remove a external callback using its id |
| "blind_1.Clear_callbacks() | - | - | Remove all external registered callbacks for updates of the blind |
| method | arguments | argument type | explanation |
| ------------------------------------- | ------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| "blind_1.Update_from_cache()" | - | - | Get the status of the blind from the cache of the Motion Gateway, No 433MHz radio communication with the blind takes place |
| "blind_1.Update()" | - | - | Get the status of the blind from the blind through the Motion Gateway (WiFi) using 433MHz radio communication between the gateway and the blind |
| "blind_1.Stop()" | - | - | Stop the motion of the blind |
| "blind_1.Open()" | - | - | Open the blind/move the blind up |
| "blind_1.Close()" | - | - | Close the blind/move the blind down |
| "blind_1.Set_position(50)" | postion | int (0-100) | Set the position of the blind |
| "blind_1.Set_angle(90)" | angle | int (0-180) | Set the angle/rotation of the blind |
| "blind_1.Register_callback("1", func) | id, callback | string, function | Register a external callback function for updates of the blind |
| "blind_1.Remove_callback("1") | id | string | Remove a external callback using its id |
| "blind_1.Clear_callbacks() | - | - | Remove all external registered callbacks for updates of the blind |

| property | value type | explanation |
| ------------------------- | ---------- | ----------------------------------------------------------------------------------- |
Expand Down

0 comments on commit 740859a

Please sign in to comment.