{"id":512,"date":"2020-12-26T20:31:36","date_gmt":"2020-12-26T20:31:36","guid":{"rendered":"https:\/\/work.claudiotereso.com\/?p=512"},"modified":"2020-12-28T16:30:23","modified_gmt":"2020-12-28T16:30:23","slug":"shelly-to-r","status":"publish","type":"post","link":"https:\/\/work.claudiotereso.com\/en\/shelly-to-r\/","title":{"rendered":"Experi\u00eancias em IoT: Da Shelly ao R"},"content":{"rendered":"

Os dispositivos <\/span>para casas inteligentes da <\/span>Shelly<\/em><\/span> podem ser consultados de m\u00faltiplas maneiras<\/span>, <\/span>inclusive<\/span> atrav\u00e9s de uma API web que pode ser <\/span>acedida<\/span> na Internet com qualquer sistema que efectue liga\u00e7\u00f5es HTTP\u00a0 com o m\u00e9todo<\/span>\u00a0<\/span>POST, como por exemplo a linguagem R.<\/span><\/p>\n

Decidi experimentar alguns dos dispositivos da Shelly<\/em>1<\/sup>, mais por piada do que propriamente por necessidade. Apareceram-me c\u00e1 em casa em plena pausa Natal\/Fim de ano. Como quando acabar a pausa tenho o trabalho final de Computa\u00e7\u00e3o Estat\u00edstica em R para fazer, decidi que era uma boa oportunidade para praticar.<\/p>\n

Instala\u00e7\u00e3o dos dispositivos<\/p>\n

Para os primeiros testes mandei vir uma tomada inteligente2<\/sup> e um monitorizador ambiental de Temperatura e humidade3<\/sup>, 22.30\u20ac e 23.35\u20ac respectivamente na mauser4<\/sup>. A instala\u00e7\u00e3o \u00e9 bastante simples e est\u00e1 descrita nos manuais5,6<\/sup> que acompanham os produtos. O processo resume-se a instalar a aplica\u00e7\u00e3o Shelly Cloud<\/em> num telem\u00f3vel android<\/em> ou iphone<\/em> e, depois de criar uma conta, detectar os dispositivos. Todo processo \u00e9 autom\u00e1tico e, se tudo correr bem, n\u00e3o precisa de grande interven\u00e7\u00e3o.<\/p>\n

Para podermos aceder aos dispositivos fora de casa, atrav\u00e9s do site Shelly Cloud<\/em>, temos de aceitar a op\u00e7\u00e3o \u201cconnect to cloud<\/em>\u201d sem a qual o dispositivo s\u00f3 pode ser acedido quando estamos conectados \u00e0 mesma rede wi-fi<\/em> que ele.<\/p>\n

Ap\u00f3s a instala\u00e7\u00e3o abrimos https:\/\/my.shelly.cloud\/<\/a> no browser<\/em> do computador para podermos configurar a API que nos vai permitir ler o estado dos dispositivos no R. Se tudo estiver bem configurado j\u00e1 vemos os dispositivos no site<\/em> (Figura 1).<\/p>\n

.<\/span><\/span><\/p>\n

<\/p>\n

Figura 1<\/a>: My Shelly Cloud com os dispositivos configurdas e fotografia da sala<\/a><\/p>\n

Dados para acesso \u00e0 API<\/p>\n

A API n\u00e3o precisa de ser activada nem configurada. A partir do momento que aceitamos que o nosso dispositivo se conecte \u00e0 shelly cloud<\/em> o sistema fica funcional, s\u00f3 precisamos de o usar.<\/p>\n

Para aceder aos dados precisamos de 3 pe\u00e7as de informa\u00e7\u00e3o:<\/p>\n

\n
\n
\u2022<\/span>\u00a0<\/span>O servidor a consultar<\/div>\n<\/div>\n
\n
\u2022<\/span>\u00a0<\/span>O c\u00f3digo de autoriza\u00e7\u00e3o para aceder aos dispositivos da nossa conta<\/div>\n<\/div>\n
\n
\u2022<\/span>\u00a0<\/span>O id<\/em> do dispositivo<\/div>\n<\/div>\n<\/div>\n

Os dois primeiros s\u00e3o consultados no user settings <\/em>(Figura 2).<\/p>\n

\u00a0<\/p>\n

<\/p>\n

Figura 2<\/a>: P\u00e1gina principal do MY Shelly Cloud<\/p>\n

Dentro do User Settings<\/em>, na op\u00e7\u00e3o Security \\ Autorization Cloud Key<\/em> temos um bot\u00e3o Get Key<\/em> que d\u00e1 acesso \u00e0 informa\u00e7\u00e3o que precisamos:<\/p>\n

.<\/span><\/span><\/p>\n

<\/p>\n

Figura 3<\/a>: Obter servidor e c\u00f3digo de acesso para API<\/p>\n

O id<\/em> do dispositivo \u00e9 obtido na p\u00e1gina de configura\u00e7\u00e3o respectiva, que se acede clicando no \u00edcone do dispositivo apresentado na p\u00e1gina da sala (Figura 1).<\/p>\n

A partir da p\u00e1gina do dispositivo, clicamos em Settings<\/em> e no fim da p\u00e1gina abrimos o separador Device Information<\/em> (Figura 4). O Device ID<\/em> aparece em hexadecimal e em decimal. Queremos o valor hexadecimal.<\/p>\n

<\/p>\n

Figura 4<\/a>:Configura\u00e7\u00e3o do dispositivo<\/p>\n

.<\/span><\/span><\/p>\n

Resumindo os dados necess\u00e1rios para a consulta:<\/p>\n\n\n\n\n\n
\n

Link<\/strong><\/p>\n<\/td>\n

\n

https:\/\/[servidor indicado na conta]<\/p>\n<\/td>\n<\/tr>\n

\n

Auth_key<\/strong><\/p>\n<\/td>\n

\n

[chave de autentica\u00e7\u00e3o da conta]<\/p>\n<\/td>\n<\/tr>\n

\n

Id<\/strong><\/p>\n<\/td>\n

\n

[id do dispositivo]<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Tabela 1: Dados para consulta<\/p>\n

.<\/span><\/span><\/p>\n

Aceder \u00e0 API<\/p>\n

Para aceder \u00e0 API al\u00e9m dos dados que j\u00e1 temos precisamos de indicar qual a opera\u00e7\u00e3o a realizar. Podemos ler informa\u00e7\u00e3o, mas tamb\u00e9m podemos alterar a configura\u00e7\u00e3o dos dispositivos. No nosso caso, s\u00f3 queremos ler o estado e nesse caso usamos o comando device\/status<\/em>. Para uma lista de todas as op\u00e7\u00f5es dispon\u00edveis podem ler a documenta\u00e7\u00e3o dispon\u00edvel7,8<\/sup> no site<\/em> da Shelly<\/em> onde podemos consultar, entre outras informa\u00e7\u00f5es, a informa\u00e7\u00e3o que a API no fornece:<\/p>\n

<\/p>\n

Figura 5: Atributos devolvidos pela API<\/p>\n

Para o nosso caso, interessa-nos o consumo actual (power<\/em>), o total<\/em> (di\u00e1rio) e a hora da consulta (timestamp<\/em>).<\/p>\n

Neste momento, temos tudo o que precisamos. O que queremos obter e como l\u00e1 chegar. Podemos agora ler o estado do dispositivo em R, mas antes vamos experimentar a configura\u00e7\u00e3o usando uma ferramenta mais visual onde ser\u00e1 mais f\u00e1cil detectar poss\u00edveis erros. Usamos o site<\/em> https:\/\/reqbin.com\/<\/a>. Introduzimos os dados que temos, n\u00e3o esquecendo que o m\u00e9todo a usar \u00e9 o POST, e verificamos os resultados:<\/p>\n

.<\/span><\/span><\/p>\n

\"\"<\/p>\n

Figura 6: Chamada \u00e0 API do Shelly no site Reqbin<\/p>\n

Ap\u00f3s um pedido efectuado com sucesso podemos consultar o resultado para confirmar que obtemos os dados indicados na documenta\u00e7\u00e3o:<\/p>\n

<\/p>\n

Figura 7: Dados obtidos conforme Reqbin<\/p>\n

Confirma-se que obtemos o power<\/em>, o timestamp<\/em> e o total<\/em>. Para garantir que estamos a ver a informa\u00e7\u00e3o certa , \u00e9 uma boa ideia confirmar os valores obtidos pela API com os valores que o portal indica para o dispositivo, n\u00e3o esquecendo, que como diz a API, o total \u00e9 em Watts<\/em>\/minuto e o site est\u00e1 em KWatts<\/em>\/hora.<\/p>\n

Tamb\u00e9m podemos ver que existe um campo _updated<\/em> que n\u00e3o est\u00e1 documentado e que tamb\u00e9m tem a data de leitura dos dados.<\/p>\n

Tudo confirmado e a funcionar, avancemos para o R.<\/p>\n

Da Shelly para o R<\/p>\n

A magia para colocar o R a ler o dispositivo est\u00e1 na biblioteca httr<\/em>9<\/sup> e na sua fun\u00e7\u00e3o POST. J\u00e1 vimos o que precisamos fazer, agora s\u00f3 precisamos traduzir para R, e dificilmente poderia ser mais simples:<\/p>\n

.<\/span><\/span><\/p>\n

library(httr)<\/p>\n

# Carregar vari\u00e1veis<\/p>\n

shellyurl <- “https:\/\/shelly-21-eu.shelly.cloud\/device\/status”<\/p>\n

shellybody <- list(auth_key=”NGE4ZDB1*****C43AD1E18C876″,id=”9****8″)<\/p>\n

# Executar Pedido<\/p>\n

shelly <- POST(shellyurl,body = shellybody,encode = “multipart”)<\/p>\n

# Consultar dados obtidos<\/p>\n

content(shelly)<\/p>\n

Listagem 1:Post \u00e0 API do Shelly<\/p>\n

O c\u00f3digo \u00e9 simples e n\u00e3o me parece que seja necess\u00e1ria qualquer explica\u00e7\u00e3o adicional, mas o mesmo n\u00e3o se pode dizer dos dados obtidos. O que obtemos com o content(shelly)<\/em> \u00e9, como seria de esperar e como vimos anteriormente, um sem fim de informa\u00e7\u00e3o. No entanto n\u00f3s sabemos o que queremos e s\u00f3 precisamos de procurar por esses campos no resultado:<\/p>\n

.<\/span><\/span><\/p>\n

$data$device_status$`_updated`<\/p>\n

[1] “2020-12-25 20:43:59”<\/p>\n

$data$device_status$meters[[1]]$power<\/p>\n

[1] 82.74<\/p>\n

$data$device_status$meters[[1]]$total<\/p>\n

[1] 11163<\/p>\n

.<\/span><\/span><\/p>\n

Para obtermos os valores individualmente, s\u00f3 precisamos de concatenar as duas partes, por exemplo, para obter o consumo actual, consultamos:<\/p>\n

content(shelly)$data$device_status$meters[[1]]$power<\/em><\/p>\n

Esta informa\u00e7\u00e3o j\u00e1 \u00e9 suficiente para fazer um pequeno programa: vamos ler durante uma hora, minuto a minutos os dados do nosso PlugS<\/em>:<\/p>\n

.<\/span><\/span><\/p>\n

library(httr)<\/p>\n

# Carregar vari\u00e1veis<\/p>\n

shellyurl <- “https:\/\/shelly-21-eu.shelly.cloud\/device\/status”<\/p>\n

shellybody <- list(auth_key=”NGE4ZDB1*****C43AD1E18C876″,id=”9****8″)<\/p>\n

# Executar Pedido<\/p>\n

shelly <- POST(shellyurl,body = shellybody,encode = “multipart”)<\/p>\n

# Consultar dados obtidos<\/p>\n

content(shelly)<\/p>\n

#inicializa\u00e7\u00e3o de vectores a conter as leituras<\/p>\n

datahora <- c()<\/p>\n

consumos <- c()<\/p>\n

total <- c()<\/p>\n

while (length(datahora) < 60)<\/p>\n

{<\/p>\n

\u2003\u2003# faz pedido \u00e0 API<\/p>\n

\u2003\u2003shelly <- POST(shellyurl,body = shellybody,encode = “multipart”)<\/p>\n

\u2003\u2003# guarda dados lidos para vector<\/p>\n

\u2003\u2003datahora <- c(datahora,content(shelly)$data$device_status$`_updated`)<\/p>\n

\u2003\u2003consumos <- c(consumos,content(shelly)$data$device_status$meters[[1]]$power )<\/p>\n

\u2003\u2003total <- c(total,content(shelly)$data$device_status$meters[[1]]$total )<\/p>\n

\u2003\u2003# pausa 1 minuto<\/p>\n

\u2003\u2003Sys.sleep(60)<\/p>\n

}<\/p>\n

.<\/span><\/span><\/p>\n

# visualizar resultados
par(mfrow=c(1,2))<\/p>\n

plot(total,xaxt=”n”,xlab=”hora”)<\/p>\n

axis(1, at=1:60,labels=datahora)<\/p>\n

plot(consumos,xaxt=”n”,xlab=”hora”)<\/p>\n

axis(1, at=1:60,labels=datahora)<\/p>\n

Listagem 2: Ler uma hora de consumos<\/p>\n

<\/p>\n

Gr\u00e1fico 1: Resultados de 1 hora de consumos<\/p>\n

.<\/span><\/span><\/p>\n

Ler dados de outro tipo de dispositivo passa por um processo id\u00eantico. \u00c9 s\u00f3 obter o id<\/em> do dispositivo e consultar a documenta\u00e7\u00e3o para perceber o que a API disponibiliza. Por exemplo, o c\u00f3digo seguinte l\u00ea a temperatura e humidade do sensor respectivo:<\/p>\n

.<\/span><\/span><\/p>\n

library(httr)<\/p>\n

# Carregar vari\u00e1veis<\/p>\n

shellyurl <- “https:\/\/shelly-21-eu.shelly.cloud\/device\/status”<\/p>\n

shellybody <- list(auth_key=”NGE4ZDB1*****C43AD1E18C876″,id=”A****3″)<\/p>\n

# Executar Pedido<\/p>\n

shelly <- POST(shellyurl,body = shellybody,encode = “multipart”)<\/p>\n

# Consultar informa\u00e7\u00e3o<\/p>\n

content(shelly)$data$device_status$`_updated`<\/p>\n

content(shelly)$data$device_status$tmp$tC<\/p>\n

content(shelly)$data$device_status$hum$value<\/p>\n

Listagem 3: C\u00f3digo para ler temperatura e humidade<\/p>\n

R e mais al\u00e9m<\/p>\n

Esta abordagem de ligar \u00e0 API a partir do R serve para testes e para situa\u00e7\u00f5es pontuais mas para projectos reais o ideal \u00e9 carregar os dados para uma base de dados \u00e0 qual vamos aceder com o R.<\/p>\n

Esse carregamento pode ser efectuado por uma aplica\u00e7\u00e3o criada em qualquer linguagem moderna ou at\u00e9 em servi\u00e7os que dispensam conhecimentos de programa\u00e7\u00e3o, como por exemplo o Logic Apps<\/em>10<\/sup>,<\/em> um dos in\u00fameros servi\u00e7os do Azure<\/em>11<\/sup>. Na Figura 8 est\u00e1 o fluxograma constru\u00eddo para ler a temperatura e humidade do sensor e enviar essa informa\u00e7\u00e3o por e-mail. O programa \u00e9 executado com a periocidade indicada na tarefa Recurrence<\/em>.<\/p>\n

Supostamente, \u00e9 ainda poss\u00edvel ignorar a shelly cloud<\/em> e colocar os dispositivos a enviarem informa\u00e7\u00e3o directamente para um servi\u00e7o web<\/em> que configuremos para receber a informa\u00e7\u00e3o. E digo supostamente, porque ainda n\u00e3o testei essa potencialidade.<\/p>\n

Como vemos, temos v\u00e1rias alternativas de aceder \u00e0 informa\u00e7\u00e3o dos dispositivos, s\u00f3 precisamos de ver a melhor para as nossas necessidades e limita\u00e7\u00f5es.<\/p>\n

<\/p>\n

Figura 8<\/a>: Logic Apps para ler Shelly API<\/p>\n

.<\/span><\/span><\/p>\n

Conclus\u00e3o<\/p>\n

A API da Shelly<\/em> \u00e9 de f\u00e1cil configura\u00e7\u00e3o e com acesso completo a toda a informa\u00e7\u00e3o e configura\u00e7\u00e3o dos dispositivos. Por outro lado, a biblioteca httr<\/em> \u00e9 de simples utiliza\u00e7\u00e3o. Deu algum trabalho a encontrar e encaixar todas as pe\u00e7as, mas ap\u00f3s esse esfor\u00e7o inicial o processo \u00e9 simples.<\/p>\n

.<\/span><\/span><\/p>\n

1.<\/span>\u2003\u2003Home | Shelly Cloud. 
<\/span>https:\/\/shelly.cloud\/.<\/span>

2.<\/span>\u2003\u2003Shelly Plug S | Shelly Cloud. 
https:\/\/shelly.cloud\/products\/shelly-plug-s-smart-home-automation-device\/.<\/span>

3.<\/span>\u2003\u2003Shelly H&T | Shelly Cloud. 
https:\/\/shelly.cloud\/products\/shelly-humidity-temperature-smart-home-automation-sensor\/.<\/span>

4.<\/span>\u2003\u2003Robert Mauser Lda. 
https:\/\/mauser.pt\/.<\/span>

5.<\/span>\u2003\u2003Shelly PLUGS user guide. 
https:\/\/shelly.cloud\/documents\/user_guide\/shelly_plug_s.pdf.<\/span>

6.<\/span>\u2003\u2003Shelly Humidity and Temperature Sensor H&T user guide. 
https:\/\/shelly.cloud\/documents\/user_guide\/shelly_ht.pdf.<\/span>

7.<\/span>\u2003\u2003Shelly cloud API access. 
https:\/\/shelly.cloud\/documents\/developers\/shelly_cloud_api_access.pdf.<\/span>

8.<\/span>\u2003\u2003Shelly Family Overview \u2013 API Reference. 
https:\/\/shelly-api-docs.shelly.cloud\/.<\/span>

9.<\/span>\u2003\u2003httr package | R Documentation. 
https:\/\/www.rdocumentation.org\/packages\/httr\/versions\/1.4.2.<\/span>

10.<\/span>\u2003\u2003Servi\u00e7o de Aplica\u00e7\u00f5es L\u00f3gicas | Microsoft Azure. 
https:\/\/azure.microsoft.com\/pt-pt\/services\/logic-apps\/.<\/span>

11.<\/span>\u2003\u2003Servi\u00e7os de Computa\u00e7\u00e3o na Cloud | Microsoft Azure. 
https:\/\/azure.microsoft.com\/pt-pt\/.<\/span>

.<\/span><\/span><\/pre>\n\n\n\n\n
\n    <\/div>\n\n","protected":false},"excerpt":{"rendered":"
Os dispositivos para casas inteligentes da Shelly podem ser consultados de m\u00faltiplas maneiras, inclusive atrav\u00e9s de uma API web que pode ser acedida na Internet com qualquer sistema que aceda a pedidos POST, como por exemplo a linguagem R.<\/p>","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_post_was_ever_published":false},"categories":[36,14,37],"tags":[39,38,40],"class_list":["post-512","post","type-post","status-publish","format-standard","hentry","category-iot","category-programming","category-r","tag-iot","tag-r","tag-shelly","has-post-title","has-post-date","has-post-category","has-post-tag","has-post-comment","has-post-author",""],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/work.claudiotereso.com\/en\/wp-json\/wp\/v2\/posts\/512","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/work.claudiotereso.com\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/work.claudiotereso.com\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/work.claudiotereso.com\/en\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/work.claudiotereso.com\/en\/wp-json\/wp\/v2\/comments?post=512"}],"version-history":[{"count":22,"href":"https:\/\/work.claudiotereso.com\/en\/wp-json\/wp\/v2\/posts\/512\/revisions"}],"predecessor-version":[{"id":555,"href":"https:\/\/work.claudiotereso.com\/en\/wp-json\/wp\/v2\/posts\/512\/revisions\/555"}],"wp:attachment":[{"href":"https:\/\/work.claudiotereso.com\/en\/wp-json\/wp\/v2\/media?parent=512"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/work.claudiotereso.com\/en\/wp-json\/wp\/v2\/categories?post=512"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/work.claudiotereso.com\/en\/wp-json\/wp\/v2\/tags?post=512"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}