Serverpic V1 - Jusaba/Domo-Serverpic GitHub Wiki

- firmwares

	Lista los firmwares registrados para cada uno de los dispositivos

- usuarios

	El Servidor devuelve un listado con todos los dispositivos conectados a el.
	El formato de la información es el siguiente:
			
		cliente-:-servidor-:-fecha-:-UC-:-VF -:-UV-:-AD-:-TD

			cliente.- Nombre del usuario
			servidor.- Servidor dobnde está conectado este cliente 
			fecha.- Fecha y hora a la que se proporciona la informacion
			UC.- Ultimo comando tramitado por el cliente
			VF.- Número de versión de firmware del cliente
			UV.- Ultimo valor enviado/recibido por/del cliente
			AD.- Nombre del cliente push/telegram al que notificar el aviso desconexión
			TD.- Tipo de dispositivo para HomeKit

- servidores

	El Servidor devuelve un listado con los servidores conectados al ‘mundo’ al que pertenece el usuario 
	que lo solicita.
	El formato de la información es el siguiente:

		servidor-:-IP-:CC -:-fecha-:-VF

			servidor.- Nombre del servidor
			IP.- Dirección IP del servidor
			CC.- Número de clientes conectados a ese servidor
			fecha.- Fecha y hora a la que se proporciona la informacion
			VF.- Versión de firmware del servidor 

- nombre

	Devuelve el nombre del servidor al que esta conectado el dispositivo  

- broadcast

	broadcast-:<Texto Mensaje>  

	Manda a todos los usuarios conectados al servidor el texto <Texto Mnesaje>

- info	

	Manda un broadcast con el texto #Info
	Los dispositivos conectados al servidor, responden al comando #Info proporcionando información del 
	dispositivo
	La información que transmite el dispositivo se detalla en la librería Serverpic

- avisodesconexion

	Habilita a un dispositivo para enviar avisos push o telegram de desconexion/conexión del dispotivo
	Cuando el dispositivo está habilitado, el servidor mandará un aviso Push/Telegram cuando se desconecte o reconecte al 'mundo' que pertenece

		avisodesconexion-:-<Dispositivo>-:-<on/off>-:-<CP/CT>

			Dispositivo.- Nombre del cliente al que se le desea implementar el servicio
			On/off.- Habilita/deshabilita el servicio para este cliente
			CP/CT.-	Cliente Push/Telegram al que notificar la conexión/desconexion 

- mensaje

		mensaje-:-<Usuario>-:-<Texto Mensaje>

		Manda al usuario 'Usuario' el texto 'Texto Mnesaje'

			Usuario Julian manda      mensaje-:-Pepe-:-Hola
			Usuario Pepe recibe       Julian-:-Hola

- Latido

	El Servidor devuelve Ok al dispositivo que le manda el texto Latido
	Sirve para mantener la conexión con el servidor pues, tras 4 minutos sin actividad de un dispositivo,
	el servidor cierra el socket y lo elimina de la lista activa
	Existe la opcion de enviar 

		Latido-:-<Version firmware>

	El servidor memorizará la versión de firmware 'Version firmware' para ese dispositivo

- exit

	El servidor cierra el socket del cliente que lo envia y lo elimina de la lista de usuarios activos

- buzon

	El servidor remite al dispositivo que lo solicita el ultimo mensaje que se le envio cuando estaba 
	desconectado

- lista

	Crea lista de broadcast de dispositivos

  	  	Opciones:

		lista-:-anadir-:-<Nombre Lista>-:-<Nombre Usuario> .- Añade un usuario a la lista
		lista-:-eliminar-:-<Nombre Lista>-:-<Nombre Usuario> .- Borra un usuario de la lista
		lista-:-info .- Devuleve relación de listas creadas
		lista-:-eliminar-:-<Nombre Lista> .- Elimina una lista

			Nombre Lista.- Nombre asignado a la lista
			Nombre Usuario.- Nombre del cliente  que se quiere añadir/eliminar a/de la lista

- push (deprecated)
	
	Manda un pushover
  
		push-:-<Token>-:-<KEY>-:-<Dispositivo>-:-<Titulo>-:-<Mensaje>-:-<Sonido>
              
  	  	Este comando utiliza la aplicación Pushover para mandar mensajes emergentes
  	  	a teléfonos, tablets, ....
		
			Token.-	Parametro proporcionado por Pushover en la suscripción
			KEY.- Parametro proporcionado por Pushover al crear una aplicación
			Dispositivo.- Nombre del dispositivo registrado en Pusover al que se quiere enviar la    				  notificación
			Titulo.- Titulo de la notificación
			Mensaje.- Cuerpo del mensaje de la notificación
			Sonido.- Sonido del aviso cuando se reciba en un dispositivo ( lista de sonidos en 			     Pushover)

- createpush
	
	Crea un cliente push en el servidor

		createpush-:-<Nombre cliente>-:-<Token>-:-<KEY>-:-<Dispositivo>-:-<Sonido>

			Nombre cliente.- Nombre que se le quiere asignar en el servidor al cliente push
			Token.-	Parametro proporcionado por Pushover en la suscripción
			KEY.- Parametro proporcionado por Pushover al crear una aplicación
			Dispositivo.- Nombre del dispositivo registrado en Pusover al que se quiere enviar   		          la notificación
			Sonido.- Sonido del aviso cuando se reciba en un dispositivo ( lista de sonidos enPushover)

- sendpush
	
	Manda una alerta push a un cliente registrado en el servidor

		sendpush-:-<Nombre cliente>-:-<Titulo>-:-<Cuerpo Mensaje>

			Nombre cliente.- Nombre del cliente push registrado en el servidor
			Titulo.- Titulo de la notificación
			Mensaje.- Cuerpo del mensaje de la notificación

- delpush

	Borra un cliente push del servidor

		delpush-:-<Nombre cliente>

			Nombre cliente.- Nombre del cliente push registrado en el servidor 

- pushall
	
	Lista todos los clientes push creados en el servidor

- save

	Guarda una variable en el servidor para el uso del dispositivo

		save-:-<Nombre Variable>-:-<Valor>

			Nombre Variable.- Nombre de la variable que se desea crear/actualizar
			Valor.- Valos que se le asigna a la variable

		Ejemplo:

			save-:-temperatura-:-22
        
       Para el usuario que lo manda, el servidor crea una variable llamada
       temperatura y le asigna el valor 22

- load
	
	Recupera una variable almacenada en el servidor

		load-:-<Nombre Variable>

				Nombre Variable.- Nombre de la variable que se desea crear/actualizar

		Ejemplo:

			load-:-temepratura
              
		El servidor recupera el contenido de temperatura almacenada para este dispositivo 
		y se lo envia

- delete

	Borra una variable creada por el dispositivo

		delete:-<Nombre Variable>

			Nombre Variable.- Nombre de la variable que se desea crear/actualizar

		Ejemplo:

			delete-:-temperatura

- show

	El servidor devuelve un listado con todas las variables almacenadas para este usuario

- delete

	Borra una variable de un dispositivo

		delete-:-<Dispositivo>-:-<Nombre variable>

			Dispositivo.- Nombre del dispositivo del que se quiere borrar la variable
			Nombre Variable.- Nombre de la variable que se desea borrar

- deleteall

	Borra todas las variables de un dispositivo

		deleteall-:-<Dispositivo>

			Dispositivo.- Nombre del dispositivo del que se quieren borrar todas las variable

- show

	Visualiza todas las variables de un dispositivo

		show-:-<Dispositivo>

			Dispositivo.- Nombre del dispositivo del que se quiere visualizar las variables

- showall

	Visualiza todas las variables de todos los dispositivos

- Comando

	Opciones:
		
		comando-:-add-:-<Nombre Lista>-:-<comando1>&<comando2>&..&<comandoN> 
			
			Crea una lista de comandos 

			Nombre Lista.- Nombre que se asigna a la lista de comandos
			comando1.-  Comandos que integran la lista y que se ejecutarán en orden secuencial
			comando2.-
			    .
				.
			comandoN.-	

		comando-:-delete-:-<Nombre Lista>
			
			Borra una lista de comandos

			Nombre Lista.- Nombre de la lista de comandos que se desea borrar

		comando-:-exec-:-<Nombre Lista>
			
			Ejecuta una lista de comandos

			Nombre Lista.- Nombre de la lista de comandos que se desea ejecutar
			
		comando-:-show
			
			Visualiza la lista de comandos registrados en el servidor

- cron 

	Opciones

		cron-:-add-:-<Nombre Cron>-:-<Patron temporizacion>-:-<Comando>

			Crea una nueva tarea cron 

				Nombre Cron.- Nombre que se asigna a la tarea cron
				Patron temporizacion.- Patron para la secuencia de temporizacion estilo cron de linux
				Comando.- Comando que se ejecutará con el patron seleccionado

					Ejemplo:

						cron-:-add-:-luzsalon-:-*/10 * * * * *-:-mensaje-:-luz_comedor-:-Change

		cron-:-delete-:-<Nombre Cron>

			Borra un cron existente

				Nombre Cron.- Nombre de la tarea Cron que se quiere borrar

					Ejemplo:

						cron-:-delete-:-luzsalon

		cron-:-list

				Lista todas las tareas cron registradas

-mundo

	Opciones

		mundo

			Devuelve la información del umbral de servidores y de los usuarios de Telegram habilitados 
			para recibir la alarma

			<Numero Servidores>-:-<Usuario Telegram 1>-:-...-:-<Usuario Telegram N>
		
		mundo-:-<Numero Servidores>-:-<Usuario Telegram 1>-:-...-:-<Usuario Telegram N>

			Registra los parametros bajo los que el sistema debe enviar avisos de desconexion 
			de servidores

			Numero Servidores.- Umbral de alarma para aviso de caida critica de servidores
			Usuario Telegram N.- Usuarios de telegram que recibiran la notificación.

- upload

	Cargar en el servidor un nuevo firmware de dispositivo. El servidor, ordenará a todos
	los dispositivos que usen ese firmware la carga de la nueva versión

			mundo.jusaba.es:puerto/upload.html 

				mundo.jusaba.es .- Cualquier mundo de serverpic
				puerto .- Puerto web del mundo elegido 
				( el Puerto web es el puerto de serverpic + 1 ) 	
		
		Para que la telecarga funcione correctamente, el firmware debe denominarse con el formato 
		NombreIno_VersionIno.bin, por ejemplo SonOffS20_92.bin.

		Cuando Serverpic recibe esto, manda un broadcast de actualización de firmware con el nombre
		del nuevo firmware y todos lo dispositivos con ese software se actualizarán a la nueva versión.

- dispositivos

	El Servidor manda un JSON con información de los dispositivos conectados
			
			mundo.jusaba.es:puerto/dispositivos/

				mundo.jusaba.es .- Cualquier mundo de serverpic
				puerto .- Puerto web del mundo elegido 
				( el Puerto web es el puerto de serverpic + 1 ) 	

	La estructura de la información de cada usuario es la siguiente
				{
					"dateTime": "2020-03-17T19:59:16.223+0000",
					"user": "sonoff2",
					"hostname": "jusaba_com",
					"ultimoValor": "Off",
					"lastCommand": "Latido",
					"version": "92",
					"avisoDesconexion": "Julian",
					"valores": {
      					"Frecuencia": "50.00",
      					"Amperimetro": " 0.32",
    					"FactorPotencia": "0.49",
    					"Potencia": "  36.90",
    					"Energia": "  5128.64",
    					"Voltimetro": "235.30"
					}
				}	

	No es necesario describir cada uno de los campos por ser evidente

	Como alternativa, si se el solicita un solo cliente, se obtendrán los datos solo de ese 
	cliente.
	
			mundo.jusaba.es:puerto/dispositivos/<Nombre Dispositivo>   

				Nombre Dispositivo.- Nombre del dispositivo del que se quiere recibir el JSON

- usuario

	Manda un mensaje a un dispositivo, equivale a la orden tradicional de mensaje 
	Se utiliza para enviar ordenes desde una pagina html

			mundo.jusaba.es:puerto/usuario/<Destinatario>?mensaje=<Orden>

				mundo.jusaba.es .- Cualquier mundo de serverpic
				puerto .- Puerto web del mundo elegido 
						   ( el Puerto web es el puerto de serverpic + 1 ) 	
				Destinatario .- Dispositivo/Cliente al que se le quiere enviar el mensaje
				Orden .- COntenido del mensaje que se desea enviar
===============================================
- variables

	Desde html se ha creado una facilidad para manejar las variables de un dispositivo

		mundo.jusaba.es:puerto/save/<Destinatario>/<Nombre Variable>/<Valor Variable>
			Registra un valos para una variable de un dispositivo determinado 

				mundo.jusaba.es .- Cualquier mundo de serverpic
				puerto .- Puerto web del mundo elegido 
						   ( el Puerto web es el puerto de serverpic + 1 ) 	
				Destinatario .- Dispositivo/Cliente para el que se quiere registrar una variable
				Nombre Variable.- Nombre de la variable que se desea registrar
				Valor.- Valor deseado para esa variable

		mundo.jusaba.es:puerto/load/<Destinatario>/<Nombre Variable>
			Recupera el calor de una variable almacenada en el servidor para un dispositivo
				
				mundo.jusaba.es .- Cualquier mundo de serverpic
				puerto .- Puerto web del mundo elegido 
						   ( el Puerto web es el puerto de serverpic + 1 ) 	
				Destinatario .- Dispositivo/Cliente para del que se quiere recuperar la variable
				Nombre Variable.- Nombre de la variable que se desea registrar

- Comando

	Permite ejecutar cualquier comando de sevidor o usuario desde html. Si el comando es de servidor, recibiremos
	el resultado del comando, si es de dispositivo, se ejecutará el comando en el dispositivo pero recibiremos un 'Ok'

	 	mundo.jusaba.es:puerto/comando/<Comando>

				mundo.jusaba.es .- Cualquier mundo de serverpic
				puerto .- Puerto web del mundo elegido 
						   ( el Puerto web es el puerto de serverpic + 1 ) 	
				comando.- Comando que se quiere ejecutar

				ej: picservertest.jusaba.es:2001/comando/cron-:-list  lista todos los Cron registrados


- Acceso desde Java Script

	Para acceder desde Java Scritp a las facilidades web, utilizaremos JQuery de la siguiente forma

		
		$.getJSON ( <mundo><comando><argumentos>)
		Se solicita un comando que puede devolver un Json
		
		Ejemplo:

				$.getJSON ("http://picservertest.jusaba.es:2001/dispositivos", funtion (data){
					.
					.
				})

				Recibe un Json con todos los dispositivos del mundo picservertest.jusaba.es:2001 y lo entrega en el parametro
				data de la función que tratará el Json

		$.get ( <mundo><comando><argumentos>)
		Se ejecuta un coamndo comando que puede devolver texto plano

		Ejemplos:

				$.get ("http://picservertest.jusaba.es:2001/comando/show-:-web", function (data){
					.
					.
				})
		
				Recibe como texto plano las variables del usuario web existentes en el mundo picservertest.jusaba.es:2001

				$.get ("http://picservertest.jusaba.es:2001/save/Estufa/temperatura/20", function (data){})

				Crea en el mundo picservertest.jusaba.es:2001 una variable 'temperatura' con un valor '20' para el usuario 'Estufa'

				$.get ("http://picservertest.jusaba.es:2001/load/Estufa/temperatura", function (data){

				})

				Recupera el valor de la variable temperatura del dispositivo estufa y la trata en la funcion a la que se le pasa como 
				parametro 'data'

		Las peticiones GET tienen un limite de longitud en las variables que se pasan, para solventar este problema, solo para tratamiento
		de variables se puede utilizar peticiones POST: La estructura del comando seria

		$.post ( <mundo>+'/save/'+<Dispositivo>+'/',<valor variable>)

		Ejemplo:

			$.post ("http://picservertest.jusaba.es:2001/save/Estufa/temperatura/", 20, function (data){})

			Guarda '20' en la variable 'temperatura' del dispositivo 'Estufa' del mundo http://picservertest.jusaba.es:2001

		Se ha comprobado que esta forma de mandar un post modifica el contendio de la variablecodificandola para el envio web
		por lo que en la paractica no nos sirve para interactuar con el servidor, en la practica utilizaremos AJAX

		$.ajax({
        url:"http://picservertest.jusaba.es:2001/save/Estufa/temperatura/",
        type:"POST",
        data:'20',
        contentType:"text/plain",
        dataType:"text",
        success: function(){
          alert("OK")
        }
      });       

sudo apt install default-jdk

java -version

cd /home/pi
mkdir Serverpic
cd Serverpic
curl -O -J -L 'https://julian60:[email protected]/oscarsm91/serverpic/downloads/serverpic-0.0.1-SNAPSHOT.jar'

cd /home/pi		
wget https://www.dropbox.com/s/s4dasjbtphrmzuu/ServerpicV1.deb
sudo dpkg -i ServerpicV1.deb

sudo service serverpic start
sudo service serverpic stop
sudo service serverpic restart

serverpiclog

- Con Docker, Serverpic es multiplataforma
- Se simplifica la instalación y es independiente de la plataforma
- Permite actualización automática cuando se publica una nueva versión
- Se pueden tener varios servidores independientes en una misma máquina

sudo apt-get update -y
sudo curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key add -	
sudo curl -sSL https://get.docker.com/ | sh
sudo groupadd docker
sudo usermod -aG docker pi

sudo systemctl enable docker
sudo systemctl start docker

sudo apt install -y python python-pip libffi-dev python-backports.ssl-match-hostname
sduo pip install docker-compose

sudo reboot -h now

docker run --name serverpic -p 1301:7000 -p 1302:7001 -d  --log-driver json-file --log-opt max-size=10m  jusaba/serverpic:latest -d

docker run --name serverpic_1 -p 1303:7000 -p 1304:7001 -d  --log-driver json-file --log-opt max-size=10m  jusaba/serverpic:latest -d

cd /home/pi
wget https://www.dropbox.com/s/ub3vvi2ttf17cze/Instalacion.sh
wget https://www.dropbox.com/s/08n2hgkhm4xjd8g/configuracion

nano configuracion

#----------------------------------------------------------
#Raspberry
#Cambia el password de la raspberry
#Si se quita esta linea, se mantendra el password existente
#----------------------------------------------------------
PasswordRasp=Serverpic2408
#----------------------------------------------------------
#SSH
#Cambia el puerto ssh
#Si se quita esta linea, se mantendra el puerto existente
#----------------------------------------------------------
PortSSH=1322
#----------------------------------------------------------
# Red STA 
# Este modo es STA, tanto etho como wlan0 se pueden conectar
# a una red existente
# Si se omite NombreSSID o PasswordSSID no se modifica la
# SSID existente en la raspberry
# Si se pone una direccion en IPETH0, se pondra una ip 
# estatica en eth0. Si se omite se mantendra 
# la configuracion para eth0
# Si se pone una direccion en IPWLAN0, se pondra una ip 
# estatica en wlan. Si se omite se mantendra 
# la configuracion para wlan0
# NO SE COMPRUEBAN POSIBLES ERRORES DE ASIGNACION
# LA RED DEBE SER 192.168.1.X
#----------------------------------------------------------
ModoRed=STA
NombreSSID=MiWifi
PasswordSSID=MiPassword
IPETH0=192.168.1.13
IPWLAN0=192.168.1.23
#----------------------------------------------------------
# Docker
# Se instala Docker, si se omite la linea Docker=Sim, se 
# hace una instalación sin Docker
#----------------------------------------------------------
Docker=Si

sudo reboot -h now

java -jar serverpic-0.0.1-SNAPSHOT.jar --server.port=1302 --serverpic.puerto=1301 --spring.profiles.active="mq,dns"

--server.port.- Puerto donde escucha el servidor html. Si se omite su valor es 7001
--serverpic.puerto.- Puerto donde escucha serverpic. Si se omite, su valor es 7000
--spring.profiles.active

nano /usr/local/bin/serverpic

docker run --name serverpic_test -p 2000:7000 -p 2001:7001 -d -e "SPRING_PROFILES_ACTIVE=mq,dns" -e "MUNDO=picservertest" --hostname salmeo_com --log-driver json-file --log-opt max-size=10m  jusaba/serverpic:latest -d

--server.port.- Puerto donde escucha el servidor html. Si se omite su valor es 7001
--serverpic.puero.- Puerto donde escucha serverpic. Si se omite, su valor es 7000
--MUNDO.- MUNDO en el que se quiere el servidor, podría ser uno por usuario o por instalación
--hostname.- Nombre del host donde se hospeda el servidor
--spring.profiles.active.- Variable para habilitar Serverpic como multiservidor
--log-driver.- Utiliza un controlador de registro diferente al predeterminado de Docker (json)
--log-opt max-size.- Longitud máxima del fichero de registro

"SPRING_PROFILES_ACTIVE=mq,dns,telegram"

"SPRING_PROFILES_ACTIVE=mq,dns,cron"

"SPRING_PROFILES_ACTIVE=mq,dns,telegram,cron"

--restart=always o --restart unless-stopped

 docker update --restart unless-stopped $(docker ps -q)