From 86dca2a028c0b769c42ff545bcf32ba5a32fcf88 Mon Sep 17 00:00:00 2001 From: Dmitry Mozgin Date: Sat, 20 Dec 2014 20:48:31 +0300 Subject: [PATCH] Update doc --- .gitignore | 5 +- Readme.md | 37 ++++++++++++++- beacon-keeper-app/AndroidManifest.xml | 4 +- doc/Readme.md | 36 -------------- doc/Todo.md | 68 --------------------------- 5 files changed, 42 insertions(+), 108 deletions(-) mode change 120000 => 100644 Readme.md delete mode 100644 doc/Readme.md delete mode 100644 doc/Todo.md diff --git a/.gitignore b/.gitignore index cc18aa2..e160b92 100644 --- a/.gitignore +++ b/.gitignore @@ -13,4 +13,7 @@ doc/TodoDesign.md design beacon-keeper.apk release.keystore -sign.sh \ No newline at end of file +sign.sh +doc/ +*.sig +beacon-keeper-app/gen-external-apklibs/ \ No newline at end of file diff --git a/Readme.md b/Readme.md deleted file mode 120000 index 20c0e2e..0000000 --- a/Readme.md +++ /dev/null @@ -1 +0,0 @@ -../beacon-sdk/doc/Readme.md \ No newline at end of file diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..da871bd --- /dev/null +++ b/Readme.md @@ -0,0 +1,36 @@ +Beacon Keeper +============= + +Beacon Keeper is standalone application in [Google Play Market](https://play.google.com/store/apps/details?id=com.m039.beacon.keeper.app) and this library. + +The main goal of this project is to create solid and simple library for locating and working with iBeacons for Android. + +*This library is under devolpment* + +Why use Beacon Keeper? +---------------------- + + * Locating iBeacons in background + * Dead simple [samples]() + +Thanks +------ + +[RadiusNetworks](https://github.com/RadiusNetworks) for their contributions to community and stackoverflow. + +License +------- + + Copyright (c) 2014 Dmitry Mozgin + + 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. diff --git a/beacon-keeper-app/AndroidManifest.xml b/beacon-keeper-app/AndroidManifest.xml index 4ceb0c9..c807ffe 100644 --- a/beacon-keeper-app/AndroidManifest.xml +++ b/beacon-keeper-app/AndroidManifest.xml @@ -1,8 +1,8 @@ diff --git a/doc/Readme.md b/doc/Readme.md deleted file mode 100644 index da871bd..0000000 --- a/doc/Readme.md +++ /dev/null @@ -1,36 +0,0 @@ -Beacon Keeper -============= - -Beacon Keeper is standalone application in [Google Play Market](https://play.google.com/store/apps/details?id=com.m039.beacon.keeper.app) and this library. - -The main goal of this project is to create solid and simple library for locating and working with iBeacons for Android. - -*This library is under devolpment* - -Why use Beacon Keeper? ----------------------- - - * Locating iBeacons in background - * Dead simple [samples]() - -Thanks ------- - -[RadiusNetworks](https://github.com/RadiusNetworks) for their contributions to community and stackoverflow. - -License -------- - - Copyright (c) 2014 Dmitry Mozgin - - 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. diff --git a/doc/Todo.md b/doc/Todo.md deleted file mode 100644 index 237ee65..0000000 --- a/doc/Todo.md +++ /dev/null @@ -1,68 +0,0 @@ -Основные задачи -=============== - -Основная задача - реализовать чистый background сервис для ibeacon-ов. - -Т.е. библиотека должна позволять разработчику легко интегрировать её для того, чтобы получать в своем приложении информацию о биконах в то время, когда приложение может быть не запущено. - -Ошибки -====== - -Вылетает, если запускать с 18- API - -Todo -==== - -0. Дизайн -1. Оформление к публикации - * Добавить описание в AboutActivity с сылками на github - -Цели ----- - -1. Приложение, простое, умный дом - * В бэкграунде определить, что зашел в какую-то комнату (по бикону) - * Варианты - * Вкл./Выкл. лампочки - * Плавное угасание лампочки по сигналу - * Уведомление - * Сетевой запрос - * Упрощенное описание 1 - 1 бикон, 1 комната, вкл./выкл. yeelight - * Упрощенное описание 2 - 1 бикон, 1 комната, ставить статус, что пришел домой -2. 2 приложения используют 1 сервис - * Интересна сама возможная реализация - -Дополнительно -------------- - -* Emacs проебы - 1. Можно замутить importR yasnippet (нужно manifest парсить) - -1. Создать github.io страничку с документацией (аха, щаз) -2. Создать файл Readme.md - * Упомянуть - * Если будет востребована, то добавим функционал (см. "остальное") -3. При публикации в плей обфусцировать приложение -4. Иконку на гитхаб + иконка с инициалами - -Остальное (по необходимости) ----------------------------- - -1. События на дальность - * Близок или далеко бикон -2. Событие на исчезания бикона -3. Калибровать биконы -4. Добавление и интеграция других сдк - * Например, для изменения мощности - * Суть - изменение параметров бикона -5. Закрывать плавно соединение -6. Фильтровать данные, наподобие Region - -Замечания ---------- - -* Bound service нужен будет, когда нужна будет более тесное взаимодействие с биконом. Например - приложение радар или, возможно, калибровка. -* Добавить в описание, что это эксперимент, нужен для меня, т.к. хотел в бэкграунде рюхнуть блютус -* Фильтр по региону нужен когда логика строится по регионам, т.е. это не фильтр -* Для того, чтобы foreground демка правильно отрабатывала, нужно функции вида начать сканировать, закончить сканировать -* Для того, чтобы 2 демки использовали один сервис необходимо много параметров, такие как версию, т.к. первый сервер, который попадает под эти характеристики перехватывается. При этом, если добавлять функционал одного сервиса на 2 приложения, должен быть или обязан прошлый функционал, тогда как на каждое приложение по сервису.