Skip to content

Commit 5c584b5

Browse files
mhaemingmhaeming
committed
docs: describe activities
1 parent 9d16687 commit 5c584b5

10 files changed

Lines changed: 177 additions & 2 deletions

File tree

‎docs/architecture/activities/ClassificationActivity.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Features
2+
- *CAMERA PREVIEW*: Shows a preview of the back camera of your smartphone
3+
- *OBJECT DETECTION*: Performs automatic object detection using [MobileNetV1](https://paperswithcode.com/method/mobilenetv1) and displays the objects category, confidence rating and bounding box

‎docs/architecture/activities/GroceryListActivity.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## Features
2+
- *SCROLLABLE GROCERY LIST*: A recycler view of cards, each holding the name of one grocery
3+
item on the grocery list. The card width dynamically adapts to the length of the item
4+
name. Greyed-out cards indicate that an item is in the cart.
5+
- *ADD ITEM BUTTON*: A bright red button entitled ‘Add Item’ is displayed at the bottom of
6+
the screen. If clicked, a dialog opens.
7+
- *ADD ITEM DIALOG*: Opens when the add item button is clicked. The dialog consists of a
8+
descriptive header entitled ‘Add a New Grocery Item,’ an editable text field with the hint
9+
‘Item Name,’ a positive button ‘Add,’ and a negative button ‘Cancel.’ When the dialog is
10+
opened, the keyboard is also activated. Clicking the positive button adds a new item by
11+
the input name. The negative button cancels the action.
12+
13+
## Actions
14+
- *ADDING ITEMS*: Items can be added to the list by voice command or via the ‘add item’
15+
button and corresponding dialog window. Per default, a new item is not in the cart.
16+
- *REMOVING ITEMS*: Items can be removed from the list by swiping right, left, or by voice
17+
command.
18+
- *PLACING ITEMS IN / REMOVING ITEMS FROM THE CART*: Long-clicking an item card changes the
19+
in-cart status of the item. If it is not in the cart, i.e., not greyed out, it is placed in the
20+
cart and greyed out. Else, it is taken out of the cart and colored. Alternatively, the in-
21+
cart status can also be changed by voice command.
22+
- *READING OUT AN ITEM NAME*: Clicking an item card will read out the item name.
23+
24+
## Voice Commands
25+
- "GO TO [DESIRED ACTIVITY NAME]": Navigates to the desired activity.
26+
- "ADD AN ITEM [ITEM NAME]": Adds a new item.
27+
- "REMOVE AN ITEM [ITEM NAME]": Removes the item from the list if it exists.
28+
- "ADD AN ITEM TO THE CART [ITEM NAME]": Adds the item to the cart if it exists and is not
29+
already in the cart.
30+
- "REMOVE AN ITEM FROM THE CART [ITEM NAME]": Removes the from the cart if it exists and
31+
is in the cart.
32+
- "CHECK IF AN ITEM IS ON THE LIST [ITEM NAME]": States whether the item is on the list.
33+
- "LIST ALL GROCERY ITEMS": Reads out the names of all grocery items.
34+
- "LIST ALL ITEMS IN THE CART": Reads out the names of all grocery items in the cart.
35+
- "LIST ALL ITEMS NOT IN THE CART": Reads out the name of all grocery items not in the cart.
36+
- "TELL ME MY OPTIONS": Reads out all possible voice commands for this activity.

‎docs/architecture/activities/MainActivity.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Features
2+
3+
- *NAVIGATION BUTTONS* : The Main Activity / Main Screen features a button for each of the app's components. Clicking a button initiates a new activity.
4+
5+
## Voice Commands
6+
- "GO TO [DESIRED ACTIVITIY NAME]": Navigates to the desired activity.

‎docs/architecture/activities/PlaceDetailsActivity.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Features
2+
- *SCROLLABLE PLACE DETAILS LIST*: A recycler view of place detail cards, each holding the
3+
name of a store and displaying that store’s opening hours (for the current day).
4+
- *FAVORITE ICON*: A star icon next to each place detail card indicates whether the place is a
5+
favorite. Filled-in icons are favorites; outlines are not.
6+
- *SEARCH BAR*: A button layout provided by Google. Clicking it will open the place search
7+
dialog. It has been placed underneath the voice activation button, as its layout cannot
8+
be changed and is unsuitable for visually impaired and blind people. The voice activation
9+
button acts as a reference point.
10+
- *PLACE SEARCH DIALOG*: A dialog provided by Google that searches the Google Places API
11+
for matches for a given input string. While typing, the dialog will attempt to
12+
autocomplete the input string by displaying a list of possible options.
13+
14+
## Actions
15+
- *ADDING NEW PLACES*: Places can currently only be added by clicking the search bar button
16+
and then entering a search string in the editable text field of the place search dialog.
17+
This place will be added to the place details list by clicking on a suggested match.
18+
- *DELETING PLACES*: Places can be removed from the list by swiping right, left, or by voice
19+
command.
20+
- *READING OUT AN ITEM NAME*: Clicking a place detail card will read out the place name and
21+
today’s opening hours.
22+
- *ADDING PLACES TO / REMOVING PLACES FROM FAVORITES*: A place can be added to favorites
23+
either by voice command or by clicking the favorite icon outline of the place. Clicking a
24+
filled-in favorite icon will remove the corresponding place from favorites, which can also
25+
be performed by voice command.
26+
27+
## Voice Commands
28+
- "GO TO [DESIRED ACTIVITY NAME]": Navigates to the desired activity.
29+
- "REMOVE A PLACE [ITEM NAME]": Removes the place if it exists.
30+
- "TELL ME THE OPENING HOURS OF A PLACE [ITEM NAME]": Reads out today’s opening hours of
31+
the place, if it exists.
32+
- "ADD A PLACE TO FAVORITES [ITEM NAME]": Adds the place to favorites if it exists and is
33+
not already a favorite.
34+
- "REMOVE A PLACE FROM FAVORITES [ITEM NAME]": Removes the place from favourites if it
35+
exists and is a favorite.
36+
- "LIST ALL SAVED PLACES": Reads out the names of all places on the place detail list.
37+
- "LIST MY FAVORITE PLACES": Reads out the names of all favorite places on the place detail
38+
list.
39+
- "LIST ALL OPEN PLACES": Reads out the names of all currently open places on the place
40+
detail list.
41+
- "TELL ME MY OPTIONS": Reads out all possible voice commands for this activity.

‎docs/architecture/activities/SettingsActivity.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Features
2+
- *SCREEN ON SETTINGS*: Toggles between ‘keep screen always on’ and ‘dim screen after a
3+
while’. The button is always labeled with the currently active setting so as not to have
4+
too much visual input.
5+
- *THEME SETTINGS*: Toggles between ‘light theme,’ ‘dark theme,’ and ‘default theme.’ The
6+
default theme corresponds to the phone’s system settings. The chosen theme is
7+
activated by navigating back to the Main Activity. The button is always labeled with the
8+
currently active setting so as not to have too much visual input.
9+
10+
## Voice Commands
11+
- "GO TO [DESIRED ACTIVITY NAME]": Navigates to the desired activity.
12+
- "CHANGE THEME [THEME CHOICE]: Changes the theme to the theme choice.
13+
- "CHANGE SCREEN SETTING [SCREEN SETTING CHOICE]": Changes the screen settings to the
14+
screen settings choice
15+
- "TELL ME MY OPTIONS": Reads out all possible voice commands for this activity.

‎docs/architecture/features/app_icon.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<figure markdown="span">
2+
![](../../images/favicon.png){ width="300" }
3+
<figcaption>Our current app icon.</figcaption>
4+
</figure>
5+
6+
We designed the app icon to play on the traffic safety sign for
7+
visually impaired and blind people and the focal scenario of the
8+
study project, i.e., grocery shopping.

‎docs/architecture/features/auditory_feedback.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Since the app is intended for visually impaired and blind people, visual feedback for
2+
actions is not a reliable solution. Therefore, auditory feedback is required to inform the
3+
user of any change, options or the current state of a feature. In particular, this feedback
4+
is essential for the user to be informed of actions that may have mistakenly or wrongfully
5+
been performed, for example, through accidentally touching the tactile interface and thus
6+
initiating an action or because a given voice command may have been misunderstood.
7+
8+
- CHANGE OF ACTIVITY: Whenever a new activity is opened, its name is stated out loud by
9+
the app
10+
11+
- VOICE CONTROL BUTTON: As per system default, activating and deactivating the
12+
microphone also plays a sound, which indicates that the microphone is now ‘listening’ or
13+
has stopped ‘listening.
14+
15+
- FEEDBACK ON ACTIONS: After an action is performed, whether through tactile or speech
16+
input, the app narrates the action. For example, when the theme setting has been
17+
changed.
18+
19+
- INFORMATION: If the user requests, the app will describe the current state of any feature
20+
in place of visual cues (such as coloring). Examples include listing all items on the
21+
grocery list that still need to be added to the shopping cart.

‎docs/architecture/features/visual_design.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Although the app is intended for visually impaired people, especially those with legal
2+
blindness, it has a visual layout. This has two main reasons. First, we acknowledge that
3+
communicating with the app loudly in public may not always be possible or desired. Thus,
4+
a clear, high-contrast visual design may aid in those situations for minor tasks, such as
5+
checking which activity the app is currently running in or checking if the grocery list is full
6+
or empty. Second, when accompanied by a sighted person, the app’s functionality should
7+
also be available to them.
8+
9+
- VOICE CONTROL BUTTON: The top third of the display is allocated for a bright red button,
10+
which activates the microphone and voice control mode. This size was chosen so that it
11+
could easily be tapped simply by feeling the top of the screen, and its placement was
12+
selected so as not to interfere with potential touch-activated navigation buttons at the
13+
bottom of the phone (screen). If activated, the microphone logo in its center turns
14+
green. Otherwise, it is white, indicating that no voice commands can be given at the
15+
current time. If the microphone is enabled, tapping the button again will deactivate it.
16+
17+
- DIMENSIONS: The layout is designed relative to the phone's dimensions. The button and
18+
card sizes dynamically adapt to the phone dimensions and contents, allowing for the
19+
largest possible size and, thus, the easiest possible legibility while keeping the desired
20+
relative layout.
21+
22+
- LIGHT THEME: The app provides a high-contrast light theme, in which the app background
23+
is a true white, button and card background are true black and button and card text is
24+
again a true white.
25+
26+
- DARK THEME: The app also provides a high-contrast dark theme, in which the app
27+
background is a true black, the button and card background are true white, and the
28+
button and card text is again a true black.

‎docs/architecture/overview.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,17 @@ flowchart
55
subgraph activities
66
m[MainActivity]
77
m --> GroceryListActivity
8-
m --> PlaceActivity
8+
m --> PlaceDetailsActivity
99
m --> SettingsActivity
10+
m --> ClassificationActivity
1011
12+
click m "activities/MainActivity.html"
13+
click GroceryListActivity "activities/GroceryListActivity.html"
14+
click PlaceDetailsActivity "activities/PlaceDetailsActivity.html"
15+
click SettingsActivity "activities/SettingsActivity.html"
16+
click ClassificationActivity "activities/ClassificationActivity.html"
17+
18+
1119
end
1220
subgraph utilities
1321
TextToSpeechUtility

‎mkdocs.yml‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,15 @@ nav:
6464
- Installation:
6565
- installation/install_from_actions.md
6666
- installation/install_from_release.md
67+
- Modules:
68+
- architecture/activities/MainActivity.md
69+
- architecture/activities/GroceryListActivity.md
70+
- architecture/activities/PlaceDetailsActivity.md
71+
- architecture/activities/ClassificationActivity.md
72+
- architecture/activities/SettingsActivity.md
6773
- Development:
6874
- installation/android_studio_setup.md
69-
- architecture/overview.md
75+
- architecture/overview.md
76+
- architecture/features/app_icon.md
77+
- architecture/features/visual_design.md
78+
- architecture/features/auditory_feedback.md

0 commit comments

Comments
 (0)