Permalink
Browse files

Check in the zeo data contract library project usable by others inter…

…facing

with Zeo's data store.
  • Loading branch information...
1 parent 96f0889 commit fe6224ec7dab4f20a9894a654ac34e8ac97ad2a4 @brandonedens brandonedens committed Jan 11, 2012
View
8 zeo-data-contract/AndroidManifest.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+ package="com.myzeo.android.api.data"
+ android:versionCode="1"
+ android:versionName="1.0.0">
+ <application android:label="Zeo Data Contract" >
+ </application>
+</manifest>
View
202 zeo-data-contract/LICENSE-2.0.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ 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.
View
17 zeo-data-contract/ant.properties
@@ -0,0 +1,17 @@
+# This file is used to override default values used by the Ant build system.
+#
+# This file must be checked in Version Control Systems, as it is
+# integral to the build system of your project.
+
+# This file is only used by the Ant script.
+
+# You can use this to override default values such as
+# 'source.dir' for the location of your java source folder and
+# 'out.dir' for the location of your output folder.
+
+# You can also use it define how the release builds are signed by declaring
+# the following properties:
+# 'key.store' for the location of your keystore and
+# 'key.alias' for the name of the key to use.
+# The password will be asked during the build when you use the 'release' target.
+
View
95 zeo-data-contract/build.xml
@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="ZeoDataContract" default="help">
+
+ <!-- The local.properties file is created and updated by the 'android' tool.
+ It contains the path to the SDK. It should *NOT* be checked into
+ Version Control Systems. -->
+ <property file="local.properties" />
+
+ <!-- The ant.properties file can be created by you. It is only edited by the
+ 'android' tool to add properties to it.
+ This is the place to change some Ant specific build properties.
+ Here are some properties you may want to change/update:
+
+ source.dir
+ The name of the source directory. Default is 'src'.
+ out.dir
+ The name of the output directory. Default is 'bin'.
+
+ For other overridable properties, look at the beginning of the rules
+ files in the SDK, at tools/ant/build.xml
+
+ Properties related to the SDK location or the project target should
+ be updated using the 'android' tool with the 'update' action.
+
+ This file is an integral part of the build system for your
+ application and should be checked into Version Control Systems.
+
+ -->
+ <property file="ant.properties" />
+
+ <!-- The project.properties file is created and updated by the 'android'
+ tool, as well as ADT.
+
+ This contains project specific properties such as project target, and library
+ dependencies. Lower level build properties are stored in ant.properties
+ (or in .classpath for Eclipse projects).
+
+ This file is an integral part of the build system for your
+ application and should be checked into Version Control Systems. -->
+ <loadproperties srcFile="project.properties" />
+
+ <!-- quick check on sdk.dir -->
+ <fail
+ message="sdk.dir is missing. Make sure to generate local.properties using 'android update project' or to inject it through an env var"
+ unless="sdk.dir"
+ />
+
+
+<!-- extension targets. Uncomment the ones where you want to do custom work
+ in between standard targets -->
+<!--
+ <target name="-pre-build">
+ </target>
+ <target name="-pre-compile">
+ </target>
+
+ /* This is typically used for code obfuscation.
+ Compiled code location: ${out.classes.absolute.dir}
+ If this is not done in place, override ${out.dex.input.absolute.dir} */
+ <target name="-post-compile">
+ </target>
+-->
+
+ <!-- Import the actual build file.
+
+ To customize existing targets, there are two options:
+ - Customize only one target:
+ - copy/paste the target into this file, *before* the
+ <import> task.
+ - customize it to your needs.
+ - Customize the whole content of build.xml
+ - copy/paste the content of the rules files (minus the top node)
+ into this file, replacing the <import> task.
+ - customize to your needs.
+
+ ***********************
+ ****** IMPORTANT ******
+ ***********************
+ In all cases you must update the value of version-tag below to read 'custom' instead of an integer,
+ in order to avoid having your file be overridden by tools such as "android update project"
+ -->
+ <!-- version-tag: 1 -->
+ <import file="${sdk.dir}/tools/ant/build.xml" />
+
+ <target name="doc" description="api docs" depends="clean, -compile">
+ <javadoc classpath="${sdk.dir}/platforms/android-14/android.jar:${project.libraries.jars}:."
+ destdir="docs"
+ doctitle="Zeo Data to CSV Example"
+ stylesheetfile="${sdk.dir}/docs/assets/android-developer-docs.css">
+ <link offline="true" href="http://d.android.com/reference"
+ packagelistLoc="${sdk.dir}/docs/reference"/>
+ <fileset dir="src" includes="**/*.java" />
+ </javadoc>
+ </target>
+</project>
View
40 zeo-data-contract/proguard.cfg
@@ -0,0 +1,40 @@
+-optimizationpasses 5
+-dontusemixedcaseclassnames
+-dontskipnonpubliclibraryclasses
+-dontpreverify
+-verbose
+-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
+
+-keep public class * extends android.app.Activity
+-keep public class * extends android.app.Application
+-keep public class * extends android.app.Service
+-keep public class * extends android.content.BroadcastReceiver
+-keep public class * extends android.content.ContentProvider
+-keep public class * extends android.app.backup.BackupAgentHelper
+-keep public class * extends android.preference.Preference
+-keep public class com.android.vending.licensing.ILicensingService
+
+-keepclasseswithmembernames class * {
+ native <methods>;
+}
+
+-keepclasseswithmembers class * {
+ public <init>(android.content.Context, android.util.AttributeSet);
+}
+
+-keepclasseswithmembers class * {
+ public <init>(android.content.Context, android.util.AttributeSet, int);
+}
+
+-keepclassmembers class * extends android.app.Activity {
+ public void *(android.view.View);
+}
+
+-keepclassmembers enum * {
+ public static **[] values();
+ public static ** valueOf(java.lang.String);
+}
+
+-keep class * implements android.os.Parcelable {
+ public static final android.os.Parcelable$Creator *;
+}
View
12 zeo-data-contract/project.properties
@@ -0,0 +1,12 @@
+# This file is automatically generated by Android Tools.
+# Do not modify this file -- YOUR CHANGES WILL BE ERASED!
+#
+# This file must be checked in Version Control Systems.
+#
+# To customize properties used by the Ant build system use,
+# "ant.properties", and override values to adapt the script to your
+# project structure.
+
+android.library=true
+# Project target.
+target=android-7
View
481 zeo-data-contract/src/com/myzeo/android/api/data/ZeoDataContract.java
@@ -0,0 +1,481 @@
+/* @(#)ZeoDataContract.java
+ *
+ *========================================================================
+ * Copyright 2011 by Zeo Inc. All Rights Reserved
+ *========================================================================
+ *
+ * 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.
+ *
+ * Date: $Date$
+ * Author: Brandon Edens <brandon.edens@myzeo.com>
+ * Version: $Revision$
+ */
+
+package com.myzeo.android.api.data;
+
+import android.net.Uri;
+import android.provider.BaseColumns;
+
+/**
+ * Contract that lays out what fields are available to others when accessing Zeo data from the Zeo
+ * Provider.
+ *
+ * <h1>Description</h1>
+ *
+ * <p>
+ *
+ * This contract specifies what data is made publically available by Zeo for usage with third party
+ * apps. The contract specified here is guaranteed to remain operable with the Zeo app. Please see
+ * the document TODO point to web link for further information on how to use this contract to access
+ * Zeo data from within your application.
+ *
+ * </p>
+ *
+ * <p>
+ *
+ * Please note that this contract refers to sleep episode in preference to sleep events though the
+ * actual text string is "sleep_event". This is due to the application originally using the name
+ * event to represent some time the user slept. Recently Zeo has decided that the better term for
+ * this is episode and eventually the app's internal systems will be updated to reflect this in a
+ * manner that is transparent to this contract.
+ *
+ * </p>
+ *
+ * @author Brandon Edens
+ * @version $Revision$
+ */
+public class ZeoDataContract {
+
+ /** The major version for the contract; non-backwards compatible version changes
+ * @see <a href="http://semver.org/">Semantic Versioning</a>
+ */
+ public static final int VERSION_MAJOR = 1;
+
+ /** The minor version for the contract; increments denote backwards compatible changes.
+ * @see <a href="http://semver.org/">Semantic Versioning</a>
+ */
+ public static final int VERSION_MINOR = 0;
+
+ /** The patch of the contract; indicates bug fixes.
+ * @see <a href="http://semver.org/">Semantic Versioning</a>
+ */
+ public static final int VERSION_PATCH = 0;
+
+ /**
+ * The version of the Zeo data contract.
+ * @see <a href="http://semver.org/">Semantic Versioning</a>
+ */
+ public static final String VERSION =
+ "" + VERSION_MAJOR + VERSION_MINOR + VERSION_PATCH;
+
+ /** The content authority is Zeo. */
+ public static final String CONTENT_AUTHORITY = "com.myzeo";
+
+ /** URI base of all provider queries. */
+ public static final Uri BASE_CONTENT_URI =
+ Uri.parse("content://" + CONTENT_AUTHORITY);
+
+ interface AlarmAlertEventColumns {
+ /** Foreign key pointing to the sleep episode for which this alert correspond to. */
+ String SLEEP_EPISODE_ID = "sleep_event_id";
+
+ /** The reason the alarm rang which is used in instances of smart wake to allow user to know
+ * why the Headband thought it was correct time to wake user.
+ * @see AlarmAlertEvent#ALARM_REASON_NONE
+ * @see AlarmAlertEvent#ALARM_REASON_DEEP_RISING
+ * @see AlarmAlertEvent#ALARM_REASON_NREM_TO_REM_TRANSITION
+ * @see AlarmAlertEvent#ALARM_REASON_REM_TO_NREM_TRANSITION
+ * @see AlarmAlertEvent#ALARM_REASON_WAKE_ON_WAKE
+ */
+ String REASON = "alarm_ring_reason";
+
+ /** Boolean that indicates whether or not Zeo smart wake was engaged. */
+ String SMART_WAKE = "smart_wake";
+
+ /** Unix timestamp in milliseconds marking when the alarm went off. */
+ String TIMESTAMP = "alarm_timestamp";
+
+ /** A string that indicates what wake music was used to awake the user. This can be either
+ * Zeo music or Android ringtones. A URI with content authority, content://com.myzeo.music
+ * represents Zeo music, media:// represents Android ringtone.
+ */
+ String WAKE_TONE = "wake_tone";
+
+ /** The number of minutes prior to the alarm time that the user configured the alarm to
+ * possibly awake them when smart wake is enabled.
+ */
+ String WAKE_WINDOW = "wake_window";
+ }
+
+ interface AlarmSnoozeEventColumns {
+ /** Foreign key pointing to the sleep episode for which this snooze correspond to. */
+ String SLEEP_EPISODE_ID = "sleep_event_id";
+
+ /** Number of milliseconds alarm snoozed. */
+ String DURATION = "alarm_snooze_duration";
+
+ /** Unix timestamp in milliseconds that marks the time that the user snoozed the alarm. */
+ String TIMESTAMP = "alarm_snooze_timestamp";
+ }
+
+ interface AlarmTimeoutEventColumns {
+ /** Foreign key pointing to the sleep episode for which this timeout correspond to. */
+ String SLEEP_EPISODE_ID = "sleep_event_id";
+
+ /** Number of milliseconds before alarm timed out. */
+ String DURATION = "alarm_timeout_duration";
+
+ /** Unix timestamp in milliseconds that marks the time that the alarm automatically silenced
+ * itself.
+ */
+ String TIMESTAMP = "alarm_timeout_timestamp";
+ }
+
+ interface HeadbandColumns {
+
+ /** The current mode of the sleep algorithm running on headband.
+ * @see Headband#ALGO_MODE_UNDEFINED
+ * @see Headband#ALGO_MODE_IDLE
+ * @see Headband#ALGO_MODE_TENTATIVE_ACTIVE
+ * @see Headband#ALGO_MODE_ACTIVE
+ * @see Headband#ALGO_MODE_TENTATIVE_IDLE
+ */
+ String ALGORITHM_MODE = "algorithm_mode";
+
+ /**
+ * String representation of bluetooth 42 bit address in the form of: 11:22:33:44:55:66 which
+ * is natural for constructing Android's BluetoothDevice.
+ */
+ String BLUETOOTH_ADDRESS = "bluetooth_address";
+
+ /**
+ * Bluetooth name shown to the user.
+ */
+ String BLUETOOTH_FRIENDLY_NAME = "bluetooth_friendly_name";
+
+ /**
+ * Flag indicating whether or not headband is paired to Android device. True if paired;
+ * false otherwise.
+ */
+ String BONDED = "bonded";
+
+ /**
+ * Number of milliseconds offset between Android device's notion of time versus the
+ * headband's.
+ */
+ String CLOCK_OFFSET = "clock_offset";
+
+ /**
+ * Whether or not the headband is currently connected to the Android device.
+ */
+ String CONNECTED = "connected";
+
+ /**
+ * Flag that indicates headband is docked with docking station. True if docked; false
+ * otherwise.
+ */
+ String DOCKED = "docked";
+
+ /**
+ * Flag indicating that headband is currently on user's head. True if on head; false
+ * otherwise.
+ */
+ String ON_HEAD = "on_head";
+
+ /** The software version for firmware running on Zeo headband. */
+ String SW_VERSION ="software_version";
+ }
+
+ interface SleepEpisodeColumns {
+ /** The TZ string representing timezone that this sleep event was created in.
+ * @see java.util.Timezone
+ */
+ String TIMEZONE = "timezone";
+
+ /**
+ * The starting timestamp (Unix timestamp in milliseconds) for the sleep event which is
+ * earliest point in time where sleep was registered via Headband.
+ */
+ String START_TIMESTAMP = "start_timestamp";
+
+ /**
+ * The ending timestamp for the sleep event which is latest point in time where sleep was
+ * not registered.
+ */
+ String END_TIMESTAMP = "end_timestamp";
+ }
+
+ interface SleepRecordColumns {
+ /** Foreign key pointing to the sleep episode for which this sleep record corresponds to. */
+ String SLEEP_EPISODE_ID = "sleep_event_id";
+
+ /**
+ * Number of times user awoke throughout the night of sleep.
+ */
+ String AWAKENINGS = "awakenings";
+
+ /**
+ * Binary blob containing an array of bytes where each value in array represents user's
+ * sleep stage after 30 seconds of recording by Zeo's headband.
+ * @see SleepRecord#SLEEP_STAGE_UNDEFINED
+ * @see SleepRecord#SLEEP_STAGE_WAKE
+ * @see SleepRecord#SLEEP_STAGE_LIGHT
+ * @see SleepRecord#SLEEP_STAGE_DEEP
+ * @see SleepRecord#SLEEP_STAGE_NMAX
+ */
+ String BASE_HYPNOGRAM = "base_hypnogram";
+
+ /**
+ * Number of elements contained within the base hypnogram where each element is recording of
+ * 30 seconds of sleep.
+ */
+ String BASE_HYPNOGRAM_COUNT = "base_hypnogram_count";
+
+ /**
+ * Binary blob containing an array of bytes where each value in array represents the 5
+ * minute majority sleep stage user was in derived from the base hypnogram.
+ * @see SleepRecord#SLEEP_STAGE_UNDEFINED
+ * @see SleepRecord#SLEEP_STAGE_WAKE
+ * @see SleepRecord#SLEEP_STAGE_LIGHT
+ * @see SleepRecord#SLEEP_STAGE_DEEP
+ * @see SleepRecord#SLEEP_STAGE_NMAX
+ */
+ String DISPLAY_HYPNOGRAM = "display_hypnogram";
+
+ /**
+ * Number of elements contained within the display hypnogram where each element is 5 minutes
+ * of sleep.
+ */
+ String DISPLAY_HYPNOGRAM_COUNT = "display_hypnogram_count";
+
+ /**
+ * Unix timestamp in milliseconds that represents the conclusion of a sleep record as
+ * recorded by Zeo headband.
+ */
+ String END_OF_NIGHT = "end_of_night";
+
+ /**
+ * The reason that this sleep record concluded. This field is updated as headband conditions
+ * change and allows the software to determine the ultimate fate of the recording of sleep's
+ * conclusion.
+ * @see SleepRecord#END_REASON_COMPLETE
+ * @see SleepRecord#END_REASON_ACTIVE
+ * @see SleepRecord#END_REASON_BATTERY_DIED
+ * @see SleepRecord#END_REASON_DISCONNECTED
+ * @see SleepRecord#END_REASON_SERVICE_KILLED
+ */
+ String END_REASON = "end_reason";
+
+ /** Foreign key pointing to the headband that recorded this sleep record. */
+ String HEADBAND_ID = "headband";
+
+ /** A localized form of the start of night timestamp (used for synchronization purposes). */
+ String LOCALIZED_START_OF_NIGHT = "localized_start_of_night";
+
+ /**
+ * The originating source for this record which indicates where this sleep record was
+ * gathered from.
+ * @see SleepRecord#DATA_SOURCE_PRIMARY
+ * @see SleepRecord#DATA_SOURCE_REMOTE
+ */
+ String SOURCE = "source";
+
+ /**
+ * Unix timestamp in milliseconds that represents the beginning of the recorded sleep data.
+ */
+ String START_OF_NIGHT = "start_of_night";
+
+ /**
+ * TZ string holding timezone that phone was in last time sleep record was received while
+ * algorithm was still active.
+ * @see java.util.Timezone
+ */
+ String TIMEZONE = "timezone";
+
+ /** Number of 30 second sleep epochs that user was in deep sleep. */
+ String TIME_IN_DEEP = "time_in_deep";
+
+ /** Number of 30 second sleep epochs that user was in light sleep. */
+ String TIME_IN_LIGHT = "time_in_light";
+
+ /** Number of 30 second sleep epochs that user was in REM sleep. */
+ String TIME_IN_REM = "time_in_rem";
+
+ /** Number of 30 second epochs that user was awake. */
+ String TIME_IN_WAKE = "time_in_wake";
+
+ /** Number of 30 second epochs before sleep onset (user was asleep) occurred. */
+ String TIME_TO_Z = "time_to_z";
+
+ /**
+ * Total amount of time the user was asleep; from the first epoch of sleep to last epoch of
+ * sleep.
+ */
+ String TOTAL_Z = "total_z";
+
+ /**
+ * A metric by which Zeo determines how well the user slept.
+ */
+ String ZQ_SCORE = "zq_score";
+ }
+
+ /**
+ * Generic columns that specify created/updated timestamps for usage in
+ * other tables.
+ */
+ public interface TimestampColumns {
+ /** Unix timestamp marking when this row was created. */
+ String CREATED_ON = "created_on";
+
+ /** Unix timestamp that marks last time this row was updated. */
+ String UPDATED_ON = "updated_on";
+ }
+
+ public static class AlarmAlertEvent
+ implements AlarmAlertEventColumns, BaseColumns, TimestampColumns {
+
+ /** The provider path to alarm alert information. */
+ private static final String PATH = "alarm_events";
+
+ /** The URI used to access alarm alert events. */
+ public static final Uri CONTENT_URI =
+ BASE_CONTENT_URI.buildUpon().appendPath(PATH).build();
+
+ /** No reason for ring (alarm rang at time specified by user) */
+ public static final int ALARM_REASON_NONE = 0;
+ /** Sleep algorithm detected user rising out of deep sleep */
+ public static final int ALARM_REASON_DEEP_RISING = 1;
+ /** User went from non-REM to REM sleep */
+ public static final int ALARM_REASON_NREM_TO_REM_TRANSITION = 2;
+ /** User went from rem to non-rem sleep */
+ public static final int ALARM_REASON_REM_TO_NREM_TRANSITION = 3;
+ /** User was already awake so the alarm rang. */
+ public static final int ALARM_REASON_WAKE_ON_WAKE = 4;
+ }
+
+ public static class AlarmSnoozeEvent
+ implements AlarmSnoozeEventColumns, BaseColumns, TimestampColumns {
+
+ /** Provider path to alarm snooze information. */
+ private static final String PATH = "alarm_snooze_events";
+
+ /** The URI used to access alarm snooze events. */
+ public static final Uri CONTENT_URI =
+ BASE_CONTENT_URI.buildUpon().appendPath(PATH).build();
+ }
+
+ public static class AlarmTimeoutEvent
+ implements AlarmTimeoutEventColumns, BaseColumns, TimestampColumns {
+
+ /** Provider path to alarm timeout events. */
+ private static final String PATH = "alarm_timeout_events";
+
+ /** The URI used to access alarm timeout events. */
+ public static final Uri CONTENT_URI =
+ BASE_CONTENT_URI.buildUpon().appendPath(PATH).build();
+ }
+
+ /**
+ * A sleep event or sleep episode is a meta joining table that unites various sources of sleep
+ * information into a coherent logical collection of data for a given event/episode of
+ * sleep. The mapping of real life sleep to Zeo's notion of a sleep episode/event is one to one.
+ */
+ public static class SleepEpisode
+ implements BaseColumns, SleepEpisodeColumns, TimestampColumns {
+
+ /** The provider path to the sleep events. */
+ private static final String PATH = "sleep_events";
+
+ /** The URI used to access sleep episode information. */
+ public static final Uri CONTENT_URI =
+ BASE_CONTENT_URI.buildUpon().appendPath(PATH).build();
+ }
+
+ /**
+ * Representation of the state of the Zeo headband which is gathered form the communication
+ * messaging system that occurs between the Android device and the headband.
+ */
+ public static class Headband
+ implements BaseColumns, HeadbandColumns, TimestampColumns {
+
+ /** The provider path to the headbands. */
+ private static final String PATH = "headbands";
+
+ /** URI used to access headband information. */
+ public static final Uri CONTENT_URI =
+ BASE_CONTENT_URI.buildUpon().appendPath(PATH).build();
+
+ /** Algorithm in an undefined state (not known) */
+ public static final int ALGO_MODE_UNDEFINED = -1;
+ /** Sleep algorithm is idle. */
+ public static final int ALGO_MODE_IDLE = 0;
+ /** Sleep algorithm is tentative active (starting up) */
+ public static final int ALGO_MODE_TENTATIVE_ACTIVE = 1;
+ /** Sleep algorithm is actively recording sleep. */
+ public static final int ALGO_MODE_ACTIVE = 2;
+ /** Sleep algorithm is tentative idle (shutting down) */
+ public static final int ALGO_MODE_TENTATIVE_IDLE = 3;
+ }
+
+ /**
+ * Data records sent by a Zeo headband or culled from the myzeo.com website. Regardless of the
+ * source of these records; this data represents information that Zeo recorded and processed
+ * from user's brain activity.
+ */
+ public static class SleepRecord
+ implements BaseColumns, SleepRecordColumns, TimestampColumns {
+
+ /** Path to sleep record information in the provider. */
+ private static final String PATH = "sleep_records";
+
+ /** The URI used to access sleep record data. */
+ public static final Uri CONTENT_URI =
+ BASE_CONTENT_URI.buildUpon().appendPath(PATH).build();
+
+ /** Zeo recording of sleep record concluded normally. */
+ public static final int END_REASON_COMPLETE = 0;
+ /** Headband is currently still actively recording sleep. */
+ public static final int END_REASON_ACTIVE = 1;
+ /** The battery died in the headband which stopped recording. */
+ public static final int END_REASON_BATTERY_DIED = 2;
+ /** Headband was disconnected from the Android device. */
+ public static final int END_REASON_DISCONNECTED = 3;
+ /** The Android service that interfaces with headband was killed by Android. */
+ public static final int END_REASON_SERVICE_KILLED = 4;
+
+ /** Sleep stage is unknown. */
+ public static final byte SLEEP_STAGE_UNDEFINED = 0;
+ /** User is awake. */
+ public static final byte SLEEP_STAGE_WAKE = 1;
+ /** User is in REM sleep. */
+ public static final byte SLEEP_STAGE_REM = 2;
+ /** User is in light sleep. */
+ public static final byte SLEEP_STAGE_LIGHT = 3;
+ /** User is in deep sleep. */
+ public static final byte SLEEP_STAGE_DEEP = 4;
+ /** Number of sleep stages defined. */
+ public static final int SLEEP_STAGE_NMAX = 5;
+
+ /** Data source for sleep record was the headband. */
+ public static final int DATA_SOURCE_PRIMARY = 0;
+ /** Data source for sleep record was myzeo.com */
+ public static final int DATA_SOURCE_REMOTE = 1;
+ }
+
+ /**
+ * Do not instantiate objects of type ZeoDataContract.
+ */
+ private ZeoDataContract() {
+ }
+}
+

0 comments on commit fe6224e

Please sign in to comment.