Ver Fonte

docs: fix typo

v0lp3 há 4 anos atrás
pai
commit
c3aa96c4ac
1 ficheiros alterados com 26 adições e 12 exclusões
  1. 26 12
      README.md

+ 26 - 12
README.md

@@ -1,8 +1,8 @@
-# Brother MFC-J430W protocol wrapper (wifi scanner)
+# Brother MFC-J430W WiFi scanner protocol
 
 ## Reasons
 
-_Brother MFC-J430W has already scanner driver and you can download [here](https://support.brother.com/g/b/downloadtop.aspx?c=it&lang=it&prod=mfcj430w_all)_ **but that are prebuilt binary (x86/x64) and source code isn't public**. My problem was that I wanted use scanner in my RPi4 but **those driver not works on ARM architecture**. In the end I solved this issue throught workaround using a vps... recently I resumed the project and I found a solution (partially thanks to [this](https://github.com/davidar/mfc7400c/)) and imho I think this is better than any workaround. I think that this should work on every scanner that use `brscan4`
+_Brother MFC-J430W has already scanner driver and you can download [here](https://support.brother.com/g/b/downloadtop.aspx?c=it&lang=it&prod=mfcj430w_all)_ **but that are prebuilt binary (x86/x64) and source code isn't public**. This is a problem if you want to use the scanner on ARM architecture, because if you don't have the source code of the driver you can't recompile it. Anyway this should work on every scanner that use `brscan4`, but I'm not sure.
 
 ## Scanner protocol
 
@@ -12,40 +12,48 @@ _Brother MFC-J430W has already scanner driver and you can download [here](https:
 
 When we open a connection with the scanner on port 54921, it respond with his status code:
 
-- `-401`: Scanner is busy
 - `+OK 200`: Ready to use
+- `-NG 401`: Scanner is busy
 
 ### Lease
 
 Now we can send a request that specify resolution and color mode, then scanner send to client a offer based on request.
+I called this part `lease because it recalled me _DHCP lease_
 
-Request:
+#### REQUEST
 
 ```go
 request := []byte(fmt.Sprintf("\x1bI\nR=%d,%d\nM=%s\n\x80", resolution, resolution, mode))
 sendPacket(socket, request)
 ```
 
-Response:
+#### RESPONSE
 
 `300,300,2,209,2480,294,3472`
 
 - `response[0]` `response[1]`: Resolution
-- `response[3]` `response[5]`: Dimensions in mm
-- `response[4]` `response[6]`: Dimensions in px
+- `response[3]` `response[5]`: Plane dimensions in _mm_
+- `response[4]` `response[6]`: Plane dimensions in _px_
 - `response[2]`: ?
 
-**Color mode are**:
+##### COLOR MODES
 
 - **GRAY64**: gray scale image
 - **CGRAY**: color image
+- **TEXT**: low resolution mode, **max output (304x434)** [not implemented]
 
-Resolution are **100, 150, 300, 600, 1200, 2400**.
-I called this part `leasing` because it recalled me _DHCP lease_
+##### RESOLUTIONS
+
+- 100
+- 150
+- 300
+- 600
+- 1200
+- 2400
 
 ### Automatic document feeder
 
-If specified it's possible to disable ADF and scan only one page.
+If specified **it's possible** to disable ADF and **scan only one page**.
 Omit this if you want use ADF.
 
 ```go
@@ -105,4 +113,10 @@ Usage of ./mfc-j430w:
 ## To do
 
 - [ ] Implement multi page scan for ADF
-- [ ] Add flag to output compressed image
+- [ ] Add flag to output compressed image
+
+## Credits
+
+[Andrea Maugeri](https://github.com/v0lp3)
+
+Partially thanks to [this](https://github.com/davidar/mfc7400c/)