diff --git a/docs/datastreams/aware-mysql.md b/docs/datastreams/aware-mysql.md index 9bd31a39..a47ae97d 100644 --- a/docs/datastreams/aware-mysql.md +++ b/docs/datastreams/aware-mysql.md @@ -398,7 +398,32 @@ Stream columns named `FLAG_TO_MUTATE` means they are extracted based on the `MUT - if stream's `double_convo_start` field is smaller than 9999999999, it is in seconds instead of milliseconds. Set `DOUBLE_CONVO_START` = 1000 * `double_convo_start`. - if stream's `double_convo_end` field is smaller than 9999999999, it is in seconds instead of milliseconds. Set `DOUBLE_CONVO_END` = 1000 * `double_convo_end`. - + + +??? info "PHONE_KEYBOARD" + + === "ANDROID" + + **RAPIDS_COLUMN_MAPPINGS** + + | RAPIDS column | Stream column | + |----------------------|---------------------| + | TIMESTAMP | timestamp | + | DEVICE_ID | device_id | + | PACKAGE_NAME | package_name | + | BEFORE_TEXT | before_text | + | CURRENT_TEXT | current_text | + | IS_PASSWORD | is_password | + + **MUTATION** + + - **COLUMN_MAPPINGS** (None) + - **SCRIPTS** (None) + + === "IOS" + + This sensor is not supported by iOS devices. + ??? info "PHONE_LIGHT" diff --git a/docs/datastreams/mandatory-phone-format.md b/docs/datastreams/mandatory-phone-format.md index c56f75b9..7219faea 100644 --- a/docs/datastreams/mandatory-phone-format.md +++ b/docs/datastreams/mandatory-phone-format.md @@ -110,6 +110,18 @@ This is a description of the format RAPIDS needs to process data for the followi | DOUBLE_CONVO_END | UNIX timestamp (13 digits) of the end of a conversation | +??? info "PHONE_KEYBOARD" + + | RAPIDS column | Description | + |--------------------|---------------------------------------------------------------------------| + | TIMESTAMP | An UNIX timestamp (13 digits) when a row of data was logged | + | DEVICE_ID | A string that uniquely identifies a device | + | PACKAGE_NAME | The application’s package name of keyboard interaction | + | BEFORE_TEXT | The previous keyboard input (empty if password) | + | CURRENT_TEXT | The current keyboard input (empty if password) | + | IS_PASSWORD | An integer: 0 = not password; 1 = password | + + ??? info "PHONE_LIGHT" | RAPIDS column | Description | diff --git a/src/data/streams/aware_mysql/format.yaml b/src/data/streams/aware_mysql/format.yaml index 6f45e607..ee0bd0c4 100644 --- a/src/data/streams/aware_mysql/format.yaml +++ b/src/data/streams/aware_mysql/format.yaml @@ -174,6 +174,19 @@ PHONE_CONVERSATION: SCRIPTS: # List any python or r scripts that mutate your raw data - "src/data/streams/mutations/phone/aware/conversation_ios_timestamp.R" +PHONE_KEYBOARD: + ANDROID: + RAPIDS_COLUMN_MAPPINGS: + TIMESTAMP: timestamp + DEVICE_ID: device_id + PACKAGE_NAME: package_name + BEFORE_TEXT: before_text + CURRENT_TEXT: current_text + IS_PASSWORD: is_password + MUTATION: + COLUMN_MAPPINGS: + SCRIPTS: # List any python or r scripts that mutate your raw data + PHONE_LIGHT: ANDROID: RAPIDS_COLUMN_MAPPINGS: diff --git a/src/data/streams/rapids_columns.yaml b/src/data/streams/rapids_columns.yaml index fb1fba65..af64dbdd 100644 --- a/src/data/streams/rapids_columns.yaml +++ b/src/data/streams/rapids_columns.yaml @@ -70,6 +70,14 @@ PHONE_CONVERSATION: - DOUBLE_CONVO_START - DOUBLE_CONVO_END +PHONE_KEYBOARD: + - TIMESTAMP + - DEVICE_ID + - PACKAGE_NAME + - BEFORE_TEXT + - CURRENT_TEXT + - IS_PASSWORD + PHONE_LIGHT: - TIMESTAMP - DEVICE_ID