docs: retailer packet — setup guide (.docx) + repo QR code
Adds the printed materials shipped with each device: - retailer-setup-guide.docx — non-technical 1-2 page setup guide - retailer-setup-guide.py — generator script for the .docx - doorcounter-repo-qr.png — QR code linking to the public Gitea repo Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
133
docs/retailer-setup-guide.py
Normal file
133
docs/retailer-setup-guide.py
Normal file
@@ -0,0 +1,133 @@
|
||||
from docx import Document
|
||||
from docx.shared import Pt, Inches, RGBColor
|
||||
from docx.enum.text import WD_ALIGN_PARAGRAPH
|
||||
|
||||
doc = Document()
|
||||
|
||||
for section in doc.sections:
|
||||
section.top_margin = Inches(0.6)
|
||||
section.bottom_margin = Inches(0.6)
|
||||
section.left_margin = Inches(0.8)
|
||||
section.right_margin = Inches(0.8)
|
||||
|
||||
style = doc.styles['Normal']
|
||||
style.font.name = 'Calibri'
|
||||
style.font.size = Pt(11)
|
||||
|
||||
def heading(text, size=18, color=(0x1F, 0x3A, 0x5F), space_before=6, space_after=4):
|
||||
p = doc.add_paragraph()
|
||||
p.paragraph_format.space_before = Pt(space_before)
|
||||
p.paragraph_format.space_after = Pt(space_after)
|
||||
run = p.add_run(text)
|
||||
run.bold = True
|
||||
run.font.size = Pt(size)
|
||||
run.font.color.rgb = RGBColor(*color)
|
||||
return p
|
||||
|
||||
def subheading(text):
|
||||
return heading(text, size=13, color=(0x1F, 0x3A, 0x5F), space_before=8, space_after=2)
|
||||
|
||||
def body(text, bold_lead=None):
|
||||
p = doc.add_paragraph()
|
||||
p.paragraph_format.space_after = Pt(4)
|
||||
if bold_lead:
|
||||
r = p.add_run(bold_lead)
|
||||
r.bold = True
|
||||
p.add_run(text)
|
||||
else:
|
||||
p.add_run(text)
|
||||
return p
|
||||
|
||||
def bullet(text, bold_lead=None):
|
||||
p = doc.add_paragraph(style='List Bullet')
|
||||
p.paragraph_format.space_after = Pt(2)
|
||||
if bold_lead:
|
||||
r = p.add_run(bold_lead)
|
||||
r.bold = True
|
||||
p.add_run(text)
|
||||
else:
|
||||
p.add_run(text)
|
||||
return p
|
||||
|
||||
# ---------- Title ----------
|
||||
title = doc.add_paragraph()
|
||||
title.alignment = WD_ALIGN_PARAGRAPH.CENTER
|
||||
tr = title.add_run('DoorCounter')
|
||||
tr.bold = True
|
||||
tr.font.size = Pt(28)
|
||||
tr.font.color.rgb = RGBColor(0x1F, 0x3A, 0x5F)
|
||||
|
||||
sub = doc.add_paragraph()
|
||||
sub.alignment = WD_ALIGN_PARAGRAPH.CENTER
|
||||
sr = sub.add_run('A simple, private way to count visitors to your store')
|
||||
sr.italic = True
|
||||
sr.font.size = Pt(13)
|
||||
sr.font.color.rgb = RGBColor(0x55, 0x55, 0x55)
|
||||
sub.paragraph_format.space_after = Pt(10)
|
||||
|
||||
# ---------- What it is ----------
|
||||
heading('What is in the box?', size=14)
|
||||
bullet('A small camera (about the size of a matchbox)', bold_lead='Camera — ')
|
||||
bullet('A USB cable to power it', bold_lead='Cable — ')
|
||||
bullet('A small wall plug', bold_lead='Power adapter — ')
|
||||
|
||||
body('That\'s it. There is nothing to install on your computer or phone, no software to log into, and no monthly fee.')
|
||||
|
||||
# ---------- What it does ----------
|
||||
heading('What does it do?', size=14)
|
||||
body('The camera mounts above your front door, pointing straight down at the floor. Whenever someone walks underneath, it counts them. Once an hour, it sends the count to us so we can share visitor traffic reports with you.')
|
||||
|
||||
p = doc.add_paragraph()
|
||||
p.paragraph_format.space_after = Pt(4)
|
||||
r = p.add_run('Your privacy is protected. ')
|
||||
r.bold = True
|
||||
p.add_run('The camera looks straight down at the top of people\'s heads — it cannot see faces. No video or photos are ever saved or sent anywhere. Only the count of how many people walked through.')
|
||||
|
||||
# ---------- Setup ----------
|
||||
heading('How do I set it up?', size=14)
|
||||
body('The whole process takes about 5 minutes. You will need a stepladder and your store\'s WiFi password.')
|
||||
|
||||
subheading('Step 1 — Mount the camera above your door')
|
||||
body('Use the included double-sided tape (or a screw, if you prefer) to stick the camera to the ceiling, directly above where people walk through your front door. The lens should point straight down at the floor. Aim for roughly 7 feet (about 2 meters) above the floor — most ceilings work fine.')
|
||||
|
||||
subheading('Step 2 — Plug it in')
|
||||
body('Connect the USB cable to the camera and to the wall plug. Plug the wall plug into any standard outlet. The camera will turn on automatically — you will see a small red light.')
|
||||
|
||||
subheading('Step 3 — Connect it to your WiFi')
|
||||
body('Take out your phone and open its WiFi settings. You will see a new network called "DoorCounter-Setup". Connect to it. Your phone will automatically open a setup page — enter your store\'s WiFi name and password, then tap Save.')
|
||||
body('After about 30 seconds, the red light on the camera will turn off. That means it is connected and counting. You are done!', bold_lead='')
|
||||
|
||||
# ---------- Day to day ----------
|
||||
heading('What do I do day-to-day?', size=14)
|
||||
body('Nothing. The camera works on its own, 24 hours a day. It uses about as much electricity as a nightlight (less than $1 per year), runs cool, and never needs to be touched.')
|
||||
|
||||
p = doc.add_paragraph()
|
||||
p.paragraph_format.space_after = Pt(4)
|
||||
r = p.add_run('A small light blinks each time someone walks through. ')
|
||||
r.bold = True
|
||||
p.add_run('You may notice the count happens 3–5 seconds after the person passes — that is normal.')
|
||||
|
||||
# ---------- Troubleshooting ----------
|
||||
heading('If something seems wrong', size=14)
|
||||
bullet('your WiFi password is probably wrong, or the WiFi network is out of range. Reconnect your phone to "DoorCounter-Setup" and re-enter the password.', bold_lead='Red light stays on — ')
|
||||
bullet('unplug it for 10 seconds and plug it back in.', bold_lead='No light at all — ')
|
||||
bullet('please contact us using the information below.', bold_lead='Anything else — ')
|
||||
|
||||
# ---------- Contact ----------
|
||||
heading('Questions?', size=14)
|
||||
body('We are happy to help. Reach out anytime:')
|
||||
bullet('peter@research.bike', bold_lead='Email: ')
|
||||
bullet('https://git.research.bike/Bicycle_Market_Research/DoorCounter', bold_lead='Project page: ')
|
||||
|
||||
footer = doc.add_paragraph()
|
||||
footer.alignment = WD_ALIGN_PARAGRAPH.CENTER
|
||||
fr = footer.add_run('Thank you for participating in our retail traffic study.')
|
||||
fr.italic = True
|
||||
fr.font.size = Pt(10)
|
||||
fr.font.color.rgb = RGBColor(0x77, 0x77, 0x77)
|
||||
footer.paragraph_format.space_before = Pt(12)
|
||||
|
||||
import sys
|
||||
out = sys.argv[1] if len(sys.argv) > 1 else 'retailer-setup-guide.docx'
|
||||
doc.save(out)
|
||||
print(f"wrote {out}")
|
||||
Reference in New Issue
Block a user