update

Author: arandomdev

.vscode/settings.json

@@ -6,6 +6,7 @@
 		"Nespresso's",
 		"Vertuo",
 		"Vertuoline",
-		"barcodes"
+		"barcodes",
+		"nargs"
 	]
 }

README.md

@@ -5,6 +5,24 @@ This project aims to decode and generate printable barcodes for the Nespresso's
 1. Download the latest version of python [here](https://www.python.org/downloads/). Or at least have version 3.7 or greater.
 2. Install Pillow through `pip install Pillow`
 
-### Helpful links
+# Usage
+This project has two scripts, the generator and printer.
+
+## The generator
+The generator takes a simplified form of a pod's code called the ID to generate a code that can be passed to the printer. The ID has 4 segments of 1s and 0s, for example "1100 1101 0100 001101"
+
+TODO: Example and table
+
+## The printer
+The printer takes a code and turns it into a printable image. The code should be 140 characters consisting of only 1s and 0s.
+
+```console
+> python printer.py 01110010110110010010001101010111001011010101000100110110011100011101100100010011010101110001110101010001001101010111000111010101001000110110
+
+> python printer.py -o outputPath.png 01110010110110010010001101010111001011010101000100110110011100011101100100010011010101110001110101010001001101010111000111010101001000110110
+```
+
+
+# Helpful links
 * https://www.reddit.com/r/nespresso/comments/d9xnv9/breaking_the_nespresso_vertuo_barcodes/
 * https://www.reddit.com/r/nespresso/comments/okc1vx/breaking_the_nespresso_vertuo_barcodes_part_2/

generator.py

@@ -1,20 +1,20 @@
-"""Used to generate a custom barcode.
+"""Used to generate a custom code.
 
-This Script is used to generate a custom code that can be passed to
+This script is used to generate a custom code that can be passed to
 the printer script.
 
-Each code can be summarized in 4 segments, 3 four character segments and 1 six
+Each ID can be summarized in 4 segments, 3 four character segments and 1 six
 character segment. For example "1100 1101 0100 001101"
 """
 
 import argparse
 from functools import partial
 
 """
-The four segments are repeated for times with different separators in
+The four segments are repeated four times with different separators in
 between. Though the separators are the same across pods.
 
-for example, Melozio has the following code
+For example, Melozio has the following code
 
 01 1100 10 1101 10 0100 10 010110 01
 01 1100 10 1101 01 0100 01 010110 10
@@ -24,15 +24,15 @@
 """
 
 
-def _getCode() -> tuple[str, str, str, str]:
+def _getID() -> tuple[str, str, str, str]:
 	"""Get the code from the user
 	"""
 
 	parser = argparse.ArgumentParser(description="Generate a code to pass to the printer.")  # noqa
 	parser.add_argument(
-		"code",
+		"ID",
 		nargs="+",
-		help="The code to generate with. Formated like this, '1100 1101 0100 001101'"
+		help="The ID to generate a code with. Formated like this, '1100 1101 0100 001101'"  # noqa
 	)
 
 	segments = parser.parse_args().code
@@ -69,7 +69,7 @@ def _getCode() -> tuple[str, str, str, str]:
 
 
 def main():
-	seg1, seg2, seg3, seg4 = _getCode()
+	seg1, seg2, seg3, seg4 = _getID()
 
 	formatter = "01{seg1}{sep1}{seg2}{sep2}{seg3}{sep3}{seg4}{sep4}"
 	formatter = partial(

printer.py

@@ -5,8 +5,6 @@
 
 from PIL import Image, ImageDraw
 
-TEST_CODE = "01110010110110010010001101010111001011010101000100110110011100011101100100010011010101110001110101010001001101010111000111010101001000110110"  # noqa
-
 IMAGE_SIZE = 2400
 POD_OUTER_DIA = 2.26
 POD_INNER_DIA = 2.02
@@ -47,12 +45,12 @@ def _getArgs() -> _PrinterArgs:
 
 	# verify the input code
 	if len(args.code) != 140:
-		print("The input code is not 140 character!")
+		print("The code is not 140 character!")
 		parser.exit()
 		pass
 
 	if any(c not in "10" for c in args.code):
-		print("The input code has invalid characters! It can only have 1s and 0s.")
+		print("The code has invalid characters! It can only have 1s and 0s.")
 		parser.exit()
 		pass
 
@@ -123,9 +121,7 @@ def main():
 			)
 			pass
 
-		with open(outputPath, mode="wb") as outFile:
-			im.save(outFile, dpi=(DPI, DPI))
-			pass
+		im.save(outputPath)
 		pass
 	pass