Documentation and UX fixes

- Documentation improvement - Fix add minion devices list - Fix speed dial buttons UX
casanet · Mar 5, 2021 · 29c00fc · 29c00fc
2 parents 1cea8c4 + 560e693
commit 29c00fc
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -38,6 +38,12 @@ Minimal page (only 5 kb of resources should be transferred !!!) for old phones o
 
 Link to the minimal page exist in the settings 'light version' section, or just navigate to `[server-ip/host]/light-app/index.html`.
 
+## Ruining local casanet server in my computer
+
+To make it easy to use there are ready to use binaries [here](https://github.com/casanet/casanet-server/releases) just download the binary file (depend on your OS) and the `casanet.json` configuration file, It's recommanded to read the configuration section [here](./backend/README.md#configure-server). 
+
+In addination I made a [Linux deployment tutorial](./docs/LINUX.md) for a Linux based devices (raspberry pi etc.)
+
 ## Project parts + technologies
 * **[Casanet server](./backend):**
 	* **Purpose:** Control the IoT devices in a local home network.
@@ -77,12 +83,6 @@ Make sure that the IP address of your home is public and redirect ports in-home
 #### Method 2: Using casa remote server
 The casa remote server is built for this, [casanet-remote](https://github.com/casanet/remote-server) run on cloud service and used to redirect API requests to the local server.
 
-## Runinng local casanet server in my computer
-
-To make it easy to use there are ready to use binaries [here](https://github.com/casanet/casanet-server/releases) just download the binary file (depend on your OS) and the `casanet.json` configuration file, It's recommanded to read the configuration section [here](./backend/README.md#configure-server). 
-
-In addination I made a [Linux deployment tutorial](./docs/LINUX.md) for a Linux based devices (raspberry pi etc.)
-
 ## Supported IoT devices / protocols
 
 -  Orvibo (aka wiwo)
@@ -141,8 +141,14 @@ In addination I made a [Linux deployment tutorial](./docs/LINUX.md) for a Linux
 
 ## Supported soon.
 
+## Connecting devices
+
+How to connect my device to the local network and how to add it to be managed by the casa-net server?
+
+see [here](./backend/src/modules/README.md) the brands modules documentation.
+
 ## Adding other devices support
-Yes, it is possible and is welcomed, see [modules](./backend/src/modules/README.md#-for-development-only-).
+Yes, it is possible and it's welcomed! see [modules](./backend/src/modules/README.md#-for-development-only-).
 
 
 ## Using scenario

diff --git a/backend/README.md b/backend/README.md
@@ -2,14 +2,18 @@
 
 This is the casa-net local server to communicate and control IoT devices in a home.
 
-[![Build Status](https://travis-ci.org/casanet/casanet-server.svg?branch=master)](https://travis-ci.org/casanet/casanet-server)
+[![CI CD Status](https://github.com/casanet/casanet-server/workflows/casanet%20server%20CI%20CD/badge.svg?branch=master)](https://github.com/casanet/casanet-server/actions)
 [![Coverage Status](https://coveralls.io/repos/github/casanet/casanet-server/badge.svg?branch=master)](https://coveralls.io/github/casanet/casanet-server?branch=master)
 
 ### Server installation
 
+> In Linux OS, make sure `net-tools` installed (in ubuntu install it by `apt-get install net-tools`)
+
+There are ready to use binaries [here](https://github.com/casanet/casanet-server/releases) just download the binary file (depend on your OS) and the `casanet.json` configuration file. 
+
+If you prefer to build the server by your own:  
 1. Download the project via git or download files as a zip
-1. In Linux OS, make sure `net-tools` installed
-1. Install Node.js on the machine
+1. Install [Node.js](https://nodejs.org/en/download/) on the machine
 1. Navigate in a command line to `$/casanet-server/backend` and press `npm ci`
 1. Run `npm run build` command
 1. If you wish to access the dashboard using the local network, build the frontend too
@@ -32,9 +36,7 @@ Also in the `casanet.json` file, you can edit the configuration of a few stuff (
 
 #### Default user
 
-Can edit any property of the default user.
-
-Except for the user account in the email. this will be always the mac address of the machine.
+You can change the default user domain in the `casanet.json` configuration file, but not the user account in the email address. this will be always the mac address of the machine.
 (The reason is for security, the only owner of the machine should know the default username).
 
 #### HTTP/HTTPS server ports

diff --git a/backend/casanet.json b/backend/casanet.json
@@ -9,7 +9,7 @@
     "timelineDaysLength": 15,
     "defaultLockCalibrationMinutes" : 10,
     "http": {
-        "httpPort": 80,
+        "httpPort": 8080,
         "httpsPort": 443,
         "useHttps": false
     },

diff --git a/frontend/src/app/dashboard-crm/devices/devices.component.html b/frontend/src/app/dashboard-crm/devices/devices.component.html
@@ -55,8 +55,7 @@
 <div dir="ltr" *ngIf="!dataLoading" style="position: absolute; bottom: 50px;"
   [style.right]="('DIR' | translate) === 'ltr' ? '25px' : null"
   [style.left]="('DIR' | translate) === 'rtl' ? '25px' : null">
-  <eco-fab-speed-dial #allDevicesActionsFab (mouseenter)="allDevicesActionsFab.open = true"
-    (mouseleave)="allDevicesActionsFab.open = false">
+  <eco-fab-speed-dial #allDevicesActionsFab (click)="allDevicesActionsFab.open = !allDevicesActionsFab.open">
     <eco-fab-speed-dial-trigger [spin]="true">
       <button [color]="primary" mat-fab>
         <mat-icon class="spin180">more_vert</mat-icon>

diff --git a/frontend/src/app/dashboard-crm/minions/minions.component.html b/frontend/src/app/dashboard-crm/minions/minions.component.html
@@ -252,8 +252,7 @@
 <div dir="ltr" *ngIf="!dataLoading" style="position: absolute; bottom: 50px;"
     [style.right]="('DIR' | translate) === 'ltr' ? '25px' : null"
     [style.left]="('DIR' | translate) === 'rtl' ? '25px' : null">
-    <eco-fab-speed-dial #allMinionsActionsFab (mouseenter)="allMinionsActionsFab.open = true"
-        (mouseleave)="allMinionsActionsFab.open = false">
+    <eco-fab-speed-dial #allMinionsActionsFab (click)="allMinionsActionsFab.open = !allMinionsActionsFab.open">
         <eco-fab-speed-dial-trigger [spin]="true">
             <button [color]="primary" mat-fab>
                 <mat-icon class="spin180">more_vert</mat-icon>

diff --git a/frontend/src/app/dashboard-crm/operations/operations.component.html b/frontend/src/app/dashboard-crm/operations/operations.component.html
@@ -88,8 +88,7 @@
 <div dir="ltr" *ngIf="!dataLoading" style="position: absolute; bottom: 50px;"
     [style.right]="('DIR' | translate) === 'ltr' ? '25px' : null"
     [style.left]="('DIR' | translate) === 'rtl' ? '25px' : null">
-    <eco-fab-speed-dial #allOperationsActionsFab (mouseenter)="allOperationsActionsFab.open = true"
-        (mouseleave)="allOperationsActionsFab.open = false">
+    <eco-fab-speed-dial #allOperationsActionsFab (click)="allOperationsActionsFab.open = !allOperationsActionsFab.open">
         <eco-fab-speed-dial-trigger [spin]="true">
             <button [color]="primary" mat-fab>
                 <mat-icon class="spin180">more_vert</mat-icon>

diff --git a/frontend/src/app/dashboard-crm/timings/timings.component.html b/frontend/src/app/dashboard-crm/timings/timings.component.html
@@ -173,8 +173,7 @@
 <div dir="ltr" *ngIf="!dataLoading" style="position: absolute; bottom: 50px;"
     [style.right]="('DIR' | translate) === 'ltr' ? '25px' : null"
     [style.left]="('DIR' | translate) === 'rtl' ? '25px' : null">
-    <eco-fab-speed-dial #allTimingsActionsFab (mouseenter)="allTimingsActionsFab.open = true"
-        (mouseleave)="allTimingsActionsFab.open = false">
+    <eco-fab-speed-dial #allTimingsActionsFab (click)="allTimingsActionsFab.open = !allTimingsActionsFab.open">
         <eco-fab-speed-dial-trigger [spin]="true">
             <button [color]="primary" mat-fab>
                 <mat-icon class="spin180">more_vert</mat-icon>

diff --git a/frontend/src/app/dashboard-crm/users/users.component.html b/frontend/src/app/dashboard-crm/users/users.component.html
@@ -133,8 +133,7 @@
 <div dir="ltr" *ngIf="!dataLoading" style="position: absolute; bottom: 50px;"
   [style.right]="('DIR' | translate) === 'ltr' ? '25px' : null"
   [style.left]="('DIR' | translate) === 'rtl' ? '25px' : null">
-  <eco-fab-speed-dial #allDevicesActionsFab (mouseenter)="allDevicesActionsFab.open = true"
-    (mouseleave)="allDevicesActionsFab.open = false">
+  <eco-fab-speed-dial #allDevicesActionsFab (click)="allDevicesActionsFab.open = !allDevicesActionsFab.open">
     <eco-fab-speed-dial-trigger [spin]="true">
       <button [color]="primary" mat-fab>
         <mat-icon class="spin180">more_vert</mat-icon>

diff --git a/frontend/src/app/dialogs/create-minion-dialog/create-minion-dialog.component.ts b/frontend/src/app/dialogs/create-minion-dialog/create-minion-dialog.component.ts
@@ -50,7 +50,7 @@ export class CreateMinionDialogComponent implements OnInit {
     for (const device of this.devicesService.lanDevices) {
       this.devices.push({
         mac: device.mac,
-        display: device.name ||
+        display: device.name && device.name !== '------------' ? device.name :
           `${device.mac} ${device.ip} ${device.vendor ? device.vendor.substr(0, Math.min(device.vendor.length, 10)) : ''}`,
       });
     }